Skip to content

Comments

Read me merge#24

Open
twohorse0311 wants to merge 6 commits intomainfrom
read-me-merge
Open

Read me merge#24
twohorse0311 wants to merge 6 commits intomainfrom
read-me-merge

Conversation

@twohorse0311
Copy link

No description provided.

@soumyaray
Copy link

Adding branch protection so that a review is required. Let me know when you wish me to review for merging!

Copy link

@soumyaray soumyaray left a comment

Choose a reason for hiding this comment

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

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.
![](https://i.imgur.com/kKvsWMh.jpg)

Choose a reason for hiding this comment

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

Please discuss with @taylor-wu96 how to change these imgur links to local jpg or png files in a docs/images folder.

Choose a reason for hiding this comment

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

ok got it~

Copy link

@soumyaray soumyaray left a comment

Choose a reason for hiding this comment

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

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-*

@twohorse0311
Copy link
Author

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 soumyaray self-requested a review October 21, 2023 12:55
Copy link

@soumyaray soumyaray left a comment

Choose a reason for hiding this comment

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

Two more requests (sorry):

  1. rename image/ to images/ – that seems the convention I usually see
  2. put it in a docs/ folder (so, docs/images/) in case in future we have more .md documentation 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.
![](https://i.imgur.com/4jW5zd1.png)
![](image/vscode-extention.png)

Choose a reason for hiding this comment

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

nit: could use _ in image description
ex : vscode_extension

@taylor-wu96
Copy link

Two more requests (sorry):

  1. rename image/ to images/ – that seems the convention I usually see
  2. put it in a docs/ folder (so, docs/images/) in case in future we have more .md documentation files.

@taylor-wu96 can you compare the file naming conventions to what you have been implementing in moonbear?

@soumyaray I don't know whether we need a "doc" folder, because there is just one readme file~

@taylor-wu96
Copy link

Two more requests (sorry):

  1. rename image/ to images/ – that seems the convention I usually see
  2. put it in a docs/ folder (so, docs/images/) in case in future we have more .md documentation files.

@taylor-wu96 can you compare the file naming conventions to what you have been implementing in moonbear?

@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
we could place the README.md in docs folder if necessary~

@soumyaray
Copy link

Great point. But I feel that having a root /images folder makes it look like this repo is using images in some core way (like, say a web app), which it is not. Also, I strongly suspect in near future we will need a more comprehensive /docs/ folder anyway.

Copy link

@soumyaray soumyaray left a comment

Choose a reason for hiding this comment

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

Looks good!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants