-
Notifications
You must be signed in to change notification settings - Fork 10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updated init to support Quick Start setup #145
Conversation
src/templates/readme.md
Outdated
@@ -0,0 +1,42 @@ | |||
# API Mesh Starter Kit |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the sample readme from the quick start guide. We need to change this for the init command output. @jhadobe I could use your help to modify this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@revanth0212 please review this PR AdobeDocs/graphql-mesh-gateway#216. The readme in this repo should link to the documentation site after it is published.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you have a potential link for the published doc page? Ill add it the readme and the link will be active once the docs are published. Anyways these 2 PRs will go live at the same time.
Also, what do you think the contexts of this readme should be? Just a heading and a link to the doc page or something else?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@revanth0212 it depends when you want to merge this to main. i'm waiting on some url forwarding. the destination will be: https://developer.adobe.com/graphql-mesh-gateway/mesh/template (after the merge), which should take place in the next day or so (just waiting on the release to be published).
I think it should contain a brief overview of the files and their purpose, but yes, mainly a link to the docs.
b7657bc
Description
In an effort to make it easy for mesh developers to get started we have embarked on a quick start template to setup and test meshes both on the local and on github codespaces.
This PR adds the same template files to the init command to make the output of init command to look similar to the output of the template.
Draft template: https://github.com/revanth0212/api-mesh-starter-kit
Related Issue
https://jira.corp.adobe.com/browse/CEXT-3347
Motivation and Context
Better DevEx
How Has This Been Tested?
This structure has already been validated on the quick start template.
Steps:
yarn start mesh.json
aio api-mesh run mesh.json
yarn debug mesh.json
aio api-mesh run mesh.json --debug
Screenshots (if appropriate):
Types of changes
Checklist: