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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve shareable configs #7722

Merged
merged 14 commits into from
Nov 24, 2020

Conversation

HonkingGoose
Copy link
Collaborator

@HonkingGoose HonkingGoose commented Nov 13, 2020

Changes:

  • Some small textual fixes
  • Migrate large section into 2 separate tables
  • Simplify examples by only using 1 parameter instead of 2 (this also shrinks the table width)
  • Add table with GitHub/GitLab configuration examples

Context:

I think putting this information into 2 separate tables is way way clearer.
Let me know what you think of this format.

I also want some feedback on how to further shrink the table width as the names column is making the tables really long.
We don't want the table to be too big, as this will be hard to review in future PRs that change the table... 馃槃

Helps with issue #7626.

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 tick one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added unit tests, or
  • Unit tests + ran on a real repository

@HonkingGoose HonkingGoose mentioned this pull request Nov 13, 2020
52 tasks
docs/development/shareable-configs.md Outdated Show resolved Hide resolved
@rarkins
Copy link
Collaborator

rarkins commented Nov 15, 2020

We should modify this page to mention that we recommend git-based presets instead of npm, too.

@HonkingGoose
Copy link
Collaborator Author

The "new" text was copy/pasted from https://docs.renovatebot.com/config-presets/

The new table is based on the https://docs.renovatebot.com/config-presets/#preset-hosting content.

docs/development/shareable-configs.md Outdated Show resolved Hide resolved
@HonkingGoose HonkingGoose mentioned this pull request Nov 23, 2020
5 tasks
@rarkins rarkins merged commit 6afc9d8 into renovatebot:master Nov 24, 2020
@renovate-release
Copy link
Collaborator

馃帀 This PR is included in version 23.84.14 馃帀

The release is available on:

Your semantic-release bot 馃摝馃殌

@HonkingGoose HonkingGoose deleted the docs/shareable-configs branch November 24, 2020 11:02
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 25, 2020
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.

None yet

3 participants