Skip to content
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

bug fixes #262

Merged
merged 4 commits into from
May 10, 2024
Merged

bug fixes #262

merged 4 commits into from
May 10, 2024

Conversation

awsarpit
Copy link
Contributor

@awsarpit awsarpit commented Apr 11, 2024

What does this PR do and why?

This PR address some of the issues/challenges faced by the customer during a recent immersion day led by a Solution Architect.

Issue #, if available

  1. There should be a link to skip pages if it’s irrelevant (eg. if you’re running Cloud9, you should be able to jump to default VPC section)
  2. Many of the Copy utilities add a newline at the end which results in an immediate execution upon Paste into the CLI, before the learner has an opportunity to edit
  3. Local Development Setup screenshots are incorrect for user creation
  4. AWS CLI already installed on Cloud9 (version 2.13.30 as of 2023/11/07) if user installs AL2 OS. Don’t need to follow install instructions for AWS CLI
  5. Intrinsic Functions section does not clearly highlight differences between Sub and Ref commands

PR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

  • Added/Updated documentation if applicable.
  • Pre-commit checks passed.
  • Lint and Nag checks passed.
  • If releasing a new version, have you bumped the version make version part=<major|minor|patch>?

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@awsarpit awsarpit requested a review from a team as a code owner April 11, 2024 06:27
Copy link
Contributor

@rezabekf rezabekf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Many thanks for the contribution. I have provided a feedback. Particularly changes to React MD are breaking generation of code blocks. I would suggest to install preview_build tool to verify the markdown generates correctly. I have suggested the correct code to fix React MDs code block generation issues.

Thank you for updating the out of date screenshot. Going forward, we should probably remove the screenshot of the documentation/console altogether to avoid this happening in the future when there is an update to the UI. Perhaps link to official documentation is the better approach.

Lastly, the addition of extra content to intrinsic function REF vs. SUB, I have left the inline comment. Feel free to reach out directly to discuss this as I would like to understand if the customers faced any sort of confusion or further clarification is required.

Cheers, Franco

content/advanced/hooks/example-in-python/index.md Outdated Show resolved Hide resolved
content/advanced/hooks/example-in-python/index.md Outdated Show resolved Hide resolved
content/basics/templates/intrinsic-functions/index.md Outdated Show resolved Hide resolved
content/basics/templates/intrinsic-functions/index.md Outdated Show resolved Hide resolved
content/prerequisites/cloud9/index.md Outdated Show resolved Hide resolved
content/prerequisites/cloud9/index.md Outdated Show resolved Hide resolved
content/prerequisites/cloud9/index.md Outdated Show resolved Hide resolved
content/prerequisites/cloud9/index.md Outdated Show resolved Hide resolved
content/prerequisites/cloud9/index.md Outdated Show resolved Hide resolved
content/prerequisites/local-development/index.md Outdated Show resolved Hide resolved
@rezabekf rezabekf self-assigned this Apr 15, 2024
@rezabekf rezabekf added the documentation Improvements or additions to documentation label Apr 15, 2024
@awsarpit
Copy link
Contributor Author

Updated with the changes suggested

Copy link
Contributor

@rezabekf rezabekf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGMT 👍

@rezabekf rezabekf merged commit 212509b into main May 10, 2024
2 checks passed
@rezabekf rezabekf deleted the arpchoud-capstone-bugfix branch May 10, 2024 09:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants