New documentation using mkdocs #601
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…demo-store into dairiley-dairiley/mkdocs
BastLeblanc branch
gfaires
reviewed
Jun 28, 2024
docs/Available Demos/GenAI Personalized Product Descriptions.md
Outdated
Show resolved
Hide resolved
docs/Deployment/local-development/0-local-development-instructions.md
Outdated
Show resolved
Hide resolved
| > DynamoDB is one dependency that can be run locally rather than connecting to the real DynamoDB. This makes it easier to run services like the [products](https://github.com/aws-samples/retail-demo-store/tree/master/src/products) service completely local to you computer. | ||
|
|
||
| ```console | ||
| foo@bar:~$ aws sts get-session-token |
There was a problem hiding this comment.
What's this command for in this context?
There was a problem hiding this comment.
see previous comment, this section is outdated
| @@ -0,0 +1,15 @@ | |||
|
|
|||
There was a problem hiding this comment.
General comment on the Technical Guides. They seem to be copies of the Demo Guide that can be launched from within the web-ui. Therefore, we need to maintain the information in two places. Is it possible to pull this content from the demo guide?
There was a problem hiding this comment.
This is correct, I haven't found a fully automated way to do it. I see options:
- Remove the demo guide from inside the demo itself (and replace with a link to this documentation in the header or with an iframe)
- Automate the demo guide generation into
- the vue components
- this mkdocs doc
- Don't include these docs in the mkdocs and only in the demo
I prefer the first option but we would benefit from a bit of a UI refresh (a better header, remove/change the demo guide button, ...)
to be discussed?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Description of changes:
Description of testing performed to validate your changes (required if pull request includes CloudFormation or source code changes):
deploy on the dev account.
When merging we need to update the https://docs.retaildemostore.retail.aws.dev DNS and github pages configuration
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.