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: popular issues file generator #4971

Merged
merged 6 commits into from
Jun 10, 2024

Conversation

sdiazlor
Copy link
Contributor

@sdiazlor sdiazlor commented Jun 6, 2024

Description

Script to automatically retrieve the github issues and generate a doc with the most popular.

NOTE: By the moment, I left it commented in mkdocs.yml as I don't know if this will be added for 2.0. So, when merged, it's saved but not run. Using it, the docs building takes around 20 seconds more.

TO BE DISCUSSED (below a screenshot):

  1. Still not sure about the given names to each table, probably it's better to shorten them.
  2. I added it to Community, but if you think this is more suitable in other section, we can discuss it.
  3. I ran it locally, but I don't know if any external workflow must be also updated.
  4. Any other feedback is welcome!

screencapture-127-0-0-1-8000-argilla-python-community-popular-issues-2024-06-06-14_32_12

Closes #4967

Type of change

(Remember to title the PR according to the type of change)

  • Documentation update

How Has This Been Tested

  • Run with mkdocs serve

@sdiazlor sdiazlor linked an issue Jun 6, 2024 that may be closed by this pull request
@sdiazlor sdiazlor changed the base branch from develop to feat/v2.0.0 June 6, 2024 12:48
@davidberenstein1957
Copy link
Member

@sdiazlor looking great! Amazing.

I think "popular issues" does not fully cover "planned issues for upcoming release", perhaps we can change the naming to something like "issue dashboard" or something?

Additionally, would you be able to do something similar but minimal for the changelog too?

Copy link

github-actions bot commented Jun 6, 2024

The URL of the deployed environment for this PR is https://argilla-quickstart-pr-4971-ki24f765kq-no.a.run.app

@nataliaElv
Copy link
Member

Looks super cool! Will it be automated somehow or do we need to regenerate the file from time to time?

@sdiazlor
Copy link
Contributor Author

sdiazlor commented Jun 7, 2024

Looks super cool! Will it be automated somehow or do we need to regenerate the file from time to time?

@nataliaElv Great! With this, the file will be created automatically after each publication, that is, after each release :)

@nataliaElv
Copy link
Member

That sounds great! 😃 Thanks for taking care of this one.

@davidberenstein1957 davidberenstein1957 merged commit f4f0937 into feat/v2.0.0 Jun 10, 2024
7 of 8 checks passed
@davidberenstein1957 davidberenstein1957 deleted the docs/popular-issues-file-generator branch June 10, 2024 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Popular issues file generator
3 participants