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

docs: config overview #28035

Merged
merged 12 commits into from
Mar 23, 2024
Merged

docs: config overview #28035

merged 12 commits into from
Mar 23, 2024

Conversation

rarkins
Copy link
Collaborator

@rarkins rarkins commented Mar 20, 2024

Changes

Adds a new "Configuration Overview" page for user docs

Context

I don't think we've had a cohesive guide to config before, and some of the info in here perhaps is not mentioned anywhere else either.

To be merged after #27864 because I included info on Inherited config here

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

Copy link
Member

@viceice viceice left a comment

Choose a reason for hiding this comment

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

LGTM, waiting for @HonkingGoose suggestions.

You need to add this page here:

- Configuration:

docs/usage/config-overview.md Show resolved Hide resolved
docs/usage/config-overview.md Outdated Show resolved Hide resolved
docs/usage/config-overview.md Show resolved Hide resolved
Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

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

I'll let @rarkins make the changes proposed by the other reviewers first. 😉 That way I can start work from a better base for my PR that will target this PR.

Let me know when you're done making the changes, and this is ready for my in-depth review.

docs/usage/config-overview.md Show resolved Hide resolved
docs/usage/config-overview.md Outdated Show resolved Hide resolved
@rarkins rarkins requested a review from viceice March 20, 2024 14:15
docs/usage/config-overview.md Outdated Show resolved Hide resolved
docs/usage/config-overview.md Outdated Show resolved Hide resolved
docs/usage/config-overview.md Show resolved Hide resolved
docs/usage/config-overview.md Outdated Show resolved Hide resolved
@viceice
Copy link
Member

viceice commented Mar 21, 2024

this new page still needs to be added to the .pages file!

@rarkins rarkins requested a review from viceice March 22, 2024 08:21
@rarkins
Copy link
Collaborator Author

rarkins commented Mar 22, 2024

@HonkingGoose this has now been stabilized enough that I think you can safely start a PR

docs/usage/config-overview.md Outdated Show resolved Hide resolved
docs/usage/config-overview.md Outdated Show resolved Hide resolved
docs/usage/config-overview.md Show resolved Hide resolved
docs/usage/config-overview.md Outdated Show resolved Hide resolved
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
@rarkins rarkins added this pull request to the merge queue Mar 23, 2024
Merged via the queue into main with commit 3ee1a42 Mar 23, 2024
37 checks passed
@rarkins rarkins deleted the docs/config-overview branch March 23, 2024 12:29
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 37.267.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants