-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
fix: formatting to md from rst #891
Conversation
- DESIGN - README - DEVELOPMENT_GUIDE
README.md
Outdated
|
||
Learn how to get started using the SAM CLI with these guides: | ||
|
||
- [Installation](docs/installation.rst): Set up your macOS, Linux or |
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.
Should we use this time to update these links to point to the aws docs we now have?
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.
definitely. the installation docs already do, but need to move out the rest too.
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.
I wonder if we should just collapse the installation docs into the readme. Not sure if the extra hop is valuable. Or just link directly to the landing page which has the different installations: https://aws.amazon.com/serverless/sam/
Or link them here: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html but we need to update this one first to make pip an advanced install and default to installers first.
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.
yeah moved it to the landing page, this way the first options seen to install are the official installation options.
- remove sphinx builds - add links to official aws quick start documentation
seems like leftovers from aws#891
seems like leftovers from #891
Issue #, if available:
Description of changes:
Checklist:
make pr
passesBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.