Conversation
|
Adding branch protection so that a review is required. Let me know when you wish me to review for merging! |
soumyaray
left a comment
There was a problem hiding this comment.
Just left a single comment about images. Something to keep in mind for future: we need to find some way to stub SQS requests so we don't have to create a test queue, or we might want to switch to Sidekiq (instead of Shoryuken), which uses local Redis instance that is easier to setup locally.
README.md
Outdated
| When we attempt to run CodePraise, we need to replace certain tokens in the secret.yml file. One of the most critical setups is the SQS service, as it directly affects the usage of workers. | ||
|
|
||
| 1. Login [AWS](https://signin.aws.amazon.com/signin?redirect_uri=https%3A%2F%2Fconsole.aws.amazon.com%2Fconsole%2Fhome%3FhashArgs%3D%2523%26isauthcode%3Dtrue%26state%3DhashArgsFromTB_ap-southeast-2_f0f961ef2b42dff4&client_id=arn%3Aaws%3Asignin%3A%3A%3Aconsole%2Fcanvas&forceMobileApp=0&code_challenge=koB4iW2c_PuWNp6eO1klqErpW-HGUIYN8kAnMIMF4sA&code_challenge_method=SHA-256) and choose "IAM user", if you don't have an account, create a new one. | ||
|  |
There was a problem hiding this comment.
Please discuss with @taylor-wu96 how to change these imgur links to local jpg or png files in a docs/images folder.
soumyaray
left a comment
There was a problem hiding this comment.
Quick question: why name all the images as codepraise-devcontainer-*? wouldn't all the images be somehow related to codepraise-devcontainer? How about just naming them things like:
vscode-*aws-sqs-*aws-iam-*
Got it, let me rename the images. |
soumyaray
left a comment
There was a problem hiding this comment.
Two more requests (sorry):
- rename
image/toimages/– that seems the convention I usually see - put it in a
docs/folder (so,docs/images/) in case in future we have more.mddocumentation files.
@taylor-wu96 can you compare the file naming conventions to what you have been implementing in moonbear?
README.md
Outdated
| ### Connect to the DevContainer | ||
| Once you install the extension, you can click the icon of this extension, and you will see a list of container you have. | ||
|  | ||
|  |
There was a problem hiding this comment.
nit: could use _ in image description
ex : vscode_extension
@soumyaray I don't know whether we need a "doc" folder, because there is just one readme file~ |
https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes |
|
Great point. But I feel that having a root |
No description provided.