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.

Sign up for GitHub

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

Jump to bottom

Improve datasource docs generation code #19261

Closed
HonkingGoose opened this issue Dec 5, 2022 · 6 comments · Fixed by #19611
Closed

Improve datasource docs generation code #19261

HonkingGoose opened this issue Dec 5, 2022 · 6 comments · Fixed by #19611
Labels
priority-4-low Low priority, unlikely to be done unless it becomes important to more people type:docs Documentation

Comments

@HonkingGoose
Copy link
Collaborator

HonkingGoose commented Dec 5, 2022 •
edited

Describe the proposed change(s).

The sidebar of the docs is a bit messy now we've merged our navigation changes:

Steps to reproduce:

  1. Open the docs site at https://docs.renovatebot.com/modules/datasource/
  2. See the word Datasource after each name

Drop the word Datasource after each name?

- Adoptium Java Datasource
+ Adoptium Java

Drop the wall of text of Supported Datasources?

We can maybe drop the Supported Datasources list as well, as you can now use the sidebar to see what's supported? I'm talking about this wall of text:

drop-supported-datasource-blob

Maybe related issue?
@HonkingGoose HonkingGoose added type:refactor Refactoring or improving of existing code status:requirements Full requirements are not yet known, so implementation should not be started priority-5-triage labels Dec 5, 2022
@HonkingGoose

This comment was marked as resolved.

Sign in to view
@HonkingGoose HonkingGoose added type:docs Documentation and removed type:refactor Refactoring or improving of existing code labels Dec 5, 2022
@viceice viceice added priority-4-low Low priority, unlikely to be done unless it becomes important to more people and removed priority-5-triage labels Dec 5, 2022
@HonkingGoose
Copy link
Collaborator Author

@viceice do you want to be assigned to this issue?

@viceice
Copy link
Member

viceice commented Dec 7, 2022

@viceice do you want to be assigned to this issue?

no. 🙃

@HonkingGoose
Copy link
Collaborator Author

Drop the wall of text of Supported Datasources?

We can maybe drop the Supported Datasources list as well, as you can now use the sidebar to see what's supported? I'm talking about this wall of text:

Alternative option: convert the wall of text to a proper list:

  • adoptium-java
  • artifactory
  • and so on

@rarkins
Copy link
Collaborator

rarkins commented Dec 12, 2022

On the side panel:

image

And I think we could remove all of this:

image

@HonkingGoose HonkingGoose added status:ready and removed status:requirements Full requirements are not yet known, so implementation should not be started labels Dec 12, 2022
@viceice viceice mentioned this issue Dec 30, 2022
Merged
6 tasks
@renovate-release
Copy link
Collaborator

🎉 This issue has been resolved in version 34.77.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 31, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
priority-4-low Low priority, unlikely to be done unless it becomes important to more people type:docs Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: separate pages for datasources renovatebot/renovate
4 participants
@viceice @rarkins @HonkingGoose @renovate-release