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

Fixed some broken links #76

Closed
wants to merge 0 commits into from
Closed

Fixed some broken links #76

wants to merge 0 commits into from

Conversation

mushlih-almubarak
Copy link
Contributor

No description provided.

@lolgab lolgab requested a review from prcr March 15, 2022 09:17
Copy link
Contributor

@prcr prcr left a comment

Choose a reason for hiding this comment

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

@mushlih-almubarak thanks for spotting the broken links and proposing a fix!

Your pull request includes changes to some images as well. Are these changes intended? 🤔 Could you ensure that your pull request only includes the fixed links? Thanks!

README.md Outdated
Comment on lines 119 to 120
- **If you're setting up one repository**, [obtain a project API token](https://github.com/codacy/docs/blob/master/docs/codacy-api/api-tokens.md#generating-and-revoking-project-api-tokens--idproject-api-tokens) and store it as an [encrypted secret for your **repository**](https://docs.github.com/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with the name `CODACY_PROJECT_TOKEN`.
- **If you're setting up multiple repositories**, [obtain an account API token](https://github.com/codacy/docs/blob/master/docs/codacy-api/api-tokens.md#generating-and-revoking-account-api-tokens--idaccount-api-tokens) and store it as an [encrypted secret for your **organization**](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-an-organization) with the name `CODACY_API_TOKEN`.
Copy link
Contributor

Choose a reason for hiding this comment

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

The links should point to the rendered pages on the Codacy documentation site instead:

Suggested change
- **If you're setting up one repository**, [obtain a project API token](https://github.com/codacy/docs/blob/master/docs/codacy-api/api-tokens.md#generating-and-revoking-project-api-tokens--idproject-api-tokens) and store it as an [encrypted secret for your **repository**](https://docs.github.com/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with the name `CODACY_PROJECT_TOKEN`.
- **If you're setting up multiple repositories**, [obtain an account API token](https://github.com/codacy/docs/blob/master/docs/codacy-api/api-tokens.md#generating-and-revoking-account-api-tokens--idaccount-api-tokens) and store it as an [encrypted secret for your **organization**](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-an-organization) with the name `CODACY_API_TOKEN`.
- **If you're setting up one repository**, [obtain a project API token](https://docs.codacy.com/codacy-api/api-tokens/#project-api-tokens) and store it as an [encrypted secret for your **repository**](https://docs.github.com/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with the name `CODACY_PROJECT_TOKEN`.
- **If you're setting up multiple repositories**, [obtain an account API token](https://docs.codacy.com/codacy-api/api-tokens/#account-api-tokens) and store it as an [encrypted secret for your **organization**](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-an-organization) with the name `CODACY_API_TOKEN`.

@mushlih-almubarak
Copy link
Contributor Author

Ah sorry, @prcr, that's a commit automatically by this app to compress the images in the repository, and it looks like I messed up the commit.

Because of that, I deleted your forked repository in my account and then forked it again, and now I've made changes to fix the broken link and opened this pr #77.

@prcr
Copy link
Contributor

prcr commented Mar 18, 2022

No problem, @mushlih-almubarak - we also use a similar image compression app on the main docs repository, but running once per week. 👍

I'm going to review the new pull request now.

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.

2 participants