Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
As I work through the guide, I add notes and I also read the comments…
… and adding any relevant notes I see as of May 18(ish).
- Added .idea to .gitignore
- Added .idea to Jekyll Exclude list
- [ ] Consider accessibility features
* http://www.goring.org/resources/accessibility.html
* https://github.com/benbalter/ra11y
* adding an indicator for links that open in new tabs
- [ ] Consider adding "Archived" banner to the top of any parts of the site that are kept but are not intended for current reference for example, all the pages [in this section](http://localhost:4000/guide.html#archives).
- Updated External Links to open a new tab.
- Updated SASS for blockquote within post-content to not be enormous.
- Added a few classes for Notes and Asides
- [ ] TODO: Resolve SST Console Warning [See the migration guide](https://a.co/7PzMCcy)
(node:85684) NOTE: We are formalizing our plans to enter AWS SDK for JavaScript (v2) into maintenance mode in 2023.
Please migrate your code to use AWS SDK for JavaScript (v3).
For more information, check the migration guide at https://a.co/7PzMCcy
(Use `node --trace-warnings ...` to show where the warning was created)
16:14:43.391
- [ ] TODO: Clean up legacy guide files so it doesn't clutter the current fileset.
- [ ] TODO: Correctly manage the path_id variable in code examples to ensure they are present without code duplication.
- [ ] TODO: Switch from Amplify API to RestApi or GraphQLAPI based on note in API.d.ts (See Warning in console.sst.dev)
- [ ] Consider adding a chapter on accessibility in the frontend creation section.
* [React Accessibility](https://legacy.reactjs.org/docs/accessibility.html) - New Accessibility guides are still pending based on announcement on 3/16/2023
* https://www.freecodecamp.org/news/react-accessibility-tools-build-accessible-react-apps/
* https://developer.mozilla.org/en-US/docs/Learn/Tools_and_testing/Client-side_JavaScript_frameworks/React_accessibility
- [ ] [Consider using Next.js for the guide](https://discourse.sst.dev/t/what-does-this-guide-cover/83/7?u=christinep2)
- [ ] [Consider switching example to React Native](https://discourse.sst.dev/t/what-does-this-guide-cover/83/8?u=christinep2)
_no specific changes_
- Removed link to the What is AWS Lambda chapter as it encourages skipping the rest of the current page.
- [ ] [Consider decreasing specificity in Lambda Spec Description](/chapters/what-is-aws-lambda.html#lambda-specs) - As AWS modifies its offerings, the description can be outdated. By speaking in generalities and linking directly to AWS for specificity the document will be less fragile.
- [ ] Consider specifying a timeframe on the cost calculation to account for pricing changes over time.
- Tested steps with a new AWS Account.
- Removed reference to specific language since they changed the call to action. Also removed screenshot as it was outdated.
- Updated chapter instructions & screenshots.
- Updated screenshots at 1280x783.
- Screenshots located in `create-iam-user`
- Left old screenshots in `iam-user` for other languages as I couldn't update them to match the new instructions.
- Tested steps with a clean install on Mac.
- [ ] Consider adding [Chocolatey](https://chocolatey.org/) [instructions for Windows](https://discourse.sst.dev/t/configure-the-aws-cli/86/3?u=christinep2.
- [ ] (Consider adding instructions for *NIX flavors.)[https://discourse.sst.dev/t/configure-the-aws-cli/86/5?u=christinep2]
- [ ] Consider adding a link to the AWS instructions instead, in case that is easier.
- Removed link to other chapters as it encourages skipping the current document
- Added links for the specific IDE Instructions
- [ ] Consider removing the penultimate sentence regarding the alternative guide since it is archived.
- Added "using CDK" into the first sentence based on the confusion mentioned in the chapter comments
- Changed references to pnpm
- Added question mark to title to match the other titles in the section and the title of the comments page.
- updated to pnpm
- [ ] Need to update Next Steps command line output as follows
- cd notes
- pnpm add (or npm, or yarn)
- pnpm exec sst dev
- updated to pnpm
- Added instructions for Safari et. al. users found in [this discord thread](https://discord.com/channels/983865673656705025/1102040862143303751/1102073623516282890)
- [ ] Safari instructions for mkcert usage are not working. Need to investigate further.
_no specific changes_
- updated to pnpm
- updated to typescript
- Added clarification as specified in comment
1. Regarding the statement "There’s no specific reason why we are creating a separate stack for these resources." Would it be fair to say that the decision to have separate stacks increases application maintainability? It seems like it could fall under the principle of "separation of concerns".
2. Why is the Hello World API still present in console after this step?
- updated to pnpm
- updated to typescript
- small wording changes
- moved bucket in return to above table instead of below, matching location in the stack file and alphabetically ordered.
- git commit as a one line command to facilitate using the copy option for the code.
_no specific changes_
- updated to pnpm
- updated to typescript
- Added info about DRYness and maintainability to the refactor section.
- Should we uninstall the aws-sdk (or @AWS-SDK) from functions when we install it into core?
- Should the user re-test after the refactor to ensure it still works?
- Do we need to add [this note](https://discourse.sst.dev/t/add-an-api-to-create-a-note/2451/18?u=christinep2) for Windows users into the guide?
- Referenced [this error handling blog post](https://kentcdodds.com/blog/get-a-catch-block-error-message-with-typescript) for the error code in handler.
- I'm seeing a delay as I add the API endpoints with seeing them in the console. I experienced on two different run-throughs, is this expected? If so, can we add a note to that effect at this point so people don't try and debug?
- updated to pnpm
- updated to typescript
- Updated to typescript
- Updated to use docs variable instead of hardcoded url
- Updated to typescript
- Switched to PNPM
- Used optional chaining operator for `requestContext.authorizer`. Should we have a different solution?
- Redo screenshots and update text to match new UI
- Rewrite to use the SST Secrets CLI based on the information found here: https://docs.sst.dev/config#should-i-use-configsecret-or-env-for-secrets
- Updated to typescript
- Switched to PNPM
- [ ] Consider not using [nested ternary operators](https://medium.com/@benlmsc/stop-using-nested-ternary-operators-heres-why-53e7e078e65a).
- Switch to Typescript for testing
- Switch to PNPM
- Add instructions to add Vite Test to workspace
- [ ] Consider including tests as we build out the API instead of at the end, or at least adding a note that this is a preferred approach for ensuring properly tested code.
- Switch to Typescript
- Switch to PNPM
- Switch to Typescript
- Switch to PNPM
- Switch to Typescript
- Switch to PNPM
- Minor wording changes
- [ ] Need to [replace create-react-app with one of the recommended solutions](facebook/create-react-app#13072) as create-react-app is being deprecated.
- [ ] Consider adding tests alongside new code from this point forward.
- Minor wording changes
- Update final screenshot to show tsx file instead of js file
- Switch to Typescript
- Switch to PNPM
- Minor wording changes
- Switch to Typescript
- Switch to PNPM
- Minor wording changes
- Switch to Typescript
- Switch to PNPM
- Minor wording changes
- Switch to PNPM
- Switch to Typescript
- Minor wording changes
- Switch to Typescript
- Minor wording changes
- Switch to Typescript
- Switch to PNPM
- Minor wording changes
- Switch to Typescript
- Switch to PNPM
- Minor wording changes
- Switch to Typescript
- Switch to PNPM
- Minor wording changes
- Switch to Typescript
- Switch to Typescript
- Move import of UseEffect above explainer so that consumer is not sidetracked by the import not being present.
- Switch to Typescript
- Switch to Typescript
- Switch to Typescript
- Switch to Typescript
No Changes
- Switch to Typescript
- Minor wording changes
- Switch to Typescript
- Minor wording changes
- [ ] Do we want to add the handling for UserExists in? https://discourse.sst.dev/t/signup-with-aws-cognito/130/74?u=christinep2
- Switch to Typescript
- Minor wording changes
- Switch to Typescript
- Minor wording changes
- Switch to Typescript
- Switch to Typescript
- Added helpful note from @sometimescasey
- [ ] Update troubleshooting tips if outdated.
- Switch to Typescript
- Minor wording changes
- Switch to Typescript
- Move Import immediately after adding code so consumer is not distracted by errors
- Switch to Typescript
- Switch to Typescript
- Minor wording changes
- Move Import immediately after adding code so consumer is not distracted by errors
- Switch to Typescript
- Minor wording changes
- Switch to Typescript
- Minor wording changes
- Switch to Typescript
- Minor wording changes
- Switch to Typescript
- Switch to PNPM
- Minor wording changes
- Switch to Typescript
- Switch to PNPM
- Switch to Typescript
- Switch to PNPM
No Changes
- Switch to Typescript
- Switch to Typescript
- Switch to Typescript
Skipped.
- Switch to Typescript
- Minor wording changes
- Switch to Typescript/PNPM
- Minor wording changes
- [ ] I tried switching the domain and the alias so that I could easily remove the domain alias and use it for my "real" app and leave the subdomain for this demo, but it erred with the message.
```
Error: Validation failed with the following errors:
[prod-notes-FrontendStack/ReactSite/Redirect/RedirectCertificate] DNS zone www-notes.manuals4life.com is not authoritative for certificate domain name manuals4life.com
```
In orde to keep the statement "You can switch these around so that the root domain redirects to the `www.` version as well.", I believe we'd need additional information dealing with the CAA record or whatever tripped it up.
No Changes
No Changes (other than the global new tab for external links)
- Switch References to Typescript
- Minor wording changes
- [ ] Needs new Screenshots using serverless-stack demo notes app.
- [ ] Might add a screenshot pointing at settings in the UI?
- Switch References to sst secret instead of .env.local
- Minor wording changes
- minor wording changes
No Changes
- Switch to Typescript
- Switched to `pnpm add @sentry/react` from `@sentry/browser`
- Added an ErrorInfoType
- [ ] Needs new Screenshots
- Switch to Typescript
- Switch to Typescript
- Change multiline ternary to if/else
- Updated screenshot for react error
- [ ] Needs new Screenshots for Sentry confirmations
- Switch to Typescript
- Switch to Typescript
- [ ] Logging extra information is incorrectly displaying `[object Object]`
- Switch references to Typescript
- Switch references to Typescript
- Switch references to Typescript
- Switch references to PNPM
- Updated to typescript
- Updated referenced pages What is IAM and What is an ARN
- Updated text to remove wording implying it is a step in the guide
- Updated to pnpm
- Updated to typescript- Loading branch information
1 parent
1d97cbc
commit a043b08