docs icon indicating copy to clipboard operation
docs copied to clipboard

Clarify documentation for `versioning-strategy` option

Open jeffwidman opened this issue 3 years ago â€ĸ 5 comments

We receive the occasional support request and there are also multiple issues filed against https://github.com/dependabot/dependabot-core/ asking about "I tried X strategy for Y ecosystem but it's not working".

So rewrite this sections of the docs to add some clarity:

  1. Add table illustrating how the different strategies work for a given scenario (🎩 đŸ’â€â™‚ī¸ to @jonasfj from https://github.com/dependabot/dependabot-core/issues/4979#issue-1196967453)
  2. Invert the table from "strategy -> supported ecosystems" to "ecosystem -> supported strategies" because our users arrive with questions about a given ecosystem, not a given strategy
  3. Add additional ecosystems to the list
  4. Shorten the example because we only need one, additional ones just contribute to the #walloftext feeling
  5. Re-order everything lexicographically

Hopefully this will provide better documentation that we can point users to in response to questions.

Co-authored-by: Jonas Finnemann Jensen [email protected]

Why:

Closes [issue link]

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

  • [ ] I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • [ ] For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • [ ] This pull request impacts the contribution experience
    • [ ] I have added the 'writer impact' label
    • [ ] I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

jeffwidman avatar Sep 20 '22 20:09 jeffwidman

Automatically generated comment â„šī¸

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md fpt
ghec
ghes@ 3.9 3.8 3.7 3.6
fpt
ghec
ghes@ 3.9 3.8 3.7 3.6

fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server ghae: GitHub AE

github-actions[bot] avatar Sep 20 '22 20:09 github-actions[bot]

👋 @jeffwidman - I noticed this PR is a draft. Let me know when it is ready for review and I'll get it triaged ⚡

cmwilson21 avatar Sep 21 '22 13:09 cmwilson21

A stale label has been added to this pull request because it has been open 7 days with no activity. To keep this PR open, add a comment or push a commit within 3 days.

github-actions[bot] avatar Oct 05 '22 17:10 github-actions[bot]

Not stale, just haven't gotten time to finish it out yet

jeffwidman avatar Oct 05 '22 18:10 jeffwidman

A stale label has been added to this pull request because it has been open 7 days with no activity. To keep this PR open, add a comment or push a commit within 3 days.

github-actions[bot] avatar Oct 13 '22 17:10 github-actions[bot]

@jeffwidman is this part of the doc drive for this quarter?

abdulapopoola avatar Mar 21 '23 21:03 abdulapopoola

These docs would be a huge improvement. Where's the finish line?

steveoh avatar Jul 04 '23 22:07 steveoh

@cmwilson21 this is ready for review.

Reviewers--if you have questions, feel free to also ping me on the internal company slack.

jeffwidman avatar Jul 07 '23 00:07 jeffwidman

@jeffwidman Thanks for letting me know! I'll get it on the board ⚡

cmwilson21 avatar Jul 07 '23 18:07 cmwilson21

jeffwidman:patch-4

zvailanu98 avatar Jul 17 '23 13:07 zvailanu98

Thanks! Let me incorporate these changes and then squash down to keep commit history clean.

jeffwidman avatar Jul 17 '23 19:07 jeffwidman

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues :zap:

github-actions[bot] avatar Jul 20 '23 08:07 github-actions[bot]