docs
docs copied to clipboard
Clarify documentation for `versioning-strategy` option
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:
- 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)
- 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
- Add additional ecosystems to the list
- Shorten the example because we only need one, additional ones just contribute to the #walloftext feeling
- 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")
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
đ @jeffwidman - I noticed this PR is a draft. Let me know when it is ready for review and I'll get it triaged âĄ
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.
Not stale, just haven't gotten time to finish it out yet
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.
@jeffwidman is this part of the doc drive for this quarter?
These docs would be a huge improvement. Where's the finish line?
@cmwilson21 this is ready for review.
Reviewers--if you have questions, feel free to also ping me on the internal company slack.
@jeffwidman Thanks for letting me know! I'll get it on the board âĄ
jeffwidman:patch-4
Thanks! Let me incorporate these changes and then squash down to keep commit history clean.
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: