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

Checking and fixing code snippets in documentation #9187

Merged
merged 22 commits into from
Jan 29, 2025

Conversation

yaningo
Copy link
Contributor

@yaningo yaningo commented Jan 20, 2025

Description

Updating/Fixing code snippets in several documentation pages.

Reasons

Some code snippets are incorrectly formatted or include outdated information.

Content Checklist

Please follow our style when contributing to CircleCI docs. Our style guide is here: https://circleci.com/docs/style/style-guide-overview.

Please take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs) 😸:

  • [n/a] Break up walls of text by adding paragraph breaks.
  • [n/a] Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume.
  • [n/a] Keep the title between 20 and 70 characters.
  • [n/a] Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
  • [n/a] Check all headings h1-h6 are in sentence case (only first letter is capitalized).
  • [n/a] Is there a "Next steps" section at the end of the page giving the reader a clear path to what to read next?
  • [n/a] Include relevant backlinks to other CircleCI docs/pages.

@yaningo yaningo requested review from a team as code owners January 20, 2025 14:42
Copy link
Contributor

@rosieyohannan rosieyohannan left a comment

Choose a reason for hiding this comment

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

Thanks for catching all these problems! just a couple of little changes

@@ -229,7 +229,8 @@ Using the Android orb gives you two options for deploying to the Google Play Sto

[.tab.configAndroidOrb.Use_the_deploy-to-play-store_job]
--
To deploy using the `deploy_to_play_store` job you just need to add a `android/deploy_to_play_store` job to your list of jobs in your workflow.
To deploy using the `deploy-to-play-store job you just need to add a `android/deploy_to_play_store` job to your list of jobs in your workflow.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To deploy using the `deploy-to-play-store job you just need to add a `android/deploy_to_play_store` job to your list of jobs in your workflow.
To deploy using the `deploy-to-play-store job you just need to add an `android/deploy_to_play_store` job to your list of jobs in your workflow.

@@ -273,18 +273,18 @@ Let's break down the `deploy-model-through-to-prod workflow`. Our first job is `

Copy link
Contributor

Choose a reason for hiding this comment

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

Line above I think deploy-model-through-to-prod workflow should be deploy-model-through-to-prod workflow

@yaningo yaningo requested a review from rosieyohannan January 29, 2025 15:01
@yaningo yaningo merged commit fa6cdb9 into master Jan 29, 2025
3 checks passed
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