Feedback #4
Draft
Feedback #4
Conversation
This file contains hidden or 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
finish first draft
run prettier
ealain
reviewed
Jul 7, 2023
|
|
||
| # Context | ||
|
|
||
| I work on an open source project: [sls-mentor](https://www.sls-mentor.dev/), that audits an aws stack and give advices on the best practices to configure serverless resources on AWS. |
There was a problem hiding this comment.
Suggested change
| I work on an open source project: [sls-mentor](https://www.sls-mentor.dev/), that audits an aws stack and give advices on the best practices to configure serverless resources on AWS. | |
| I am working... |
|
|
||
| - Report generation is done in a CLI ⌨️ | ||
| - The report is pretty 💄 | ||
| - As a fullstack developper, I wanted to use a tool that I know well to generate the report: [React](https://react.dev/) |
There was a problem hiding this comment.
Looks like a solution already, not a requirement.
Suggested change
| - As a fullstack developper, I wanted to use a tool that I know well to generate the report: [React](https://react.dev/) | |
| The report can be displayed in a browser |
|
|
||
|  | ||
|
|
||
| And guess what ? It is written in react ! 🚀 |
There was a problem hiding this comment.
Suggested change
| And guess what ? It is written in react ! 🚀 | |
| And guess what? It is written in React! 🚀 |
|
|
||
| It generates a dist folder with an index.html file. But if you try to open it in your browser, you will see a blank page. | ||
|
|
||
| If you open the index.html in an editor, you will notice it is almost empty, it just an empty div and some scripts to js files. |
There was a problem hiding this comment.
Suggested change
| If you open the index.html in an editor, you will notice it is almost empty, it just an empty div and some scripts to js files. | |
| If you open the index.html in an editor, you will notice it is almost empty, it's just an empty div and some scripts to js files. |
|
|
||
| # Found a typo? | ||
|
|
||
| If you've found a typo, a sentence that could be improved or anything else that should be updated on this blog post, you can access it through a git repository and make a pull request. Instead of posting a comment, please go directly to <REPO URL> and open a new pull request with your changes. |
| } | ||
| ``` | ||
|
|
||
| The placeholder `<<<RESULTS_PLACEHOLDER>>>` will be replaced by the result of the analysis. |
There was a problem hiding this comment.
I think this would be interesting to explain how this is done. In other words, how the report generator integrates with the tool that computes the score.
Yoctoboy
reviewed
Jul 13, 2023
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.
No description provided.