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

How can we make these metrics more visible? #20

Closed
sebastiaanspeck opened this issue Sep 3, 2024 · 11 comments · Fixed by #21
Closed

How can we make these metrics more visible? #20

sebastiaanspeck opened this issue Sep 3, 2024 · 11 comments · Fixed by #21
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@sebastiaanspeck
Copy link
Member

I noticed that other maintainers didn't know their language was so outdated until I opened specific issues per language. With this issue I would like to think about a way so that maintainers will see earlier that their maintained language is outdated. Signalling early keeps the pile small.

Feel free to drop your idea here

@kbdharun

@spageektti
Copy link
Member

spageektti commented Sep 3, 2024

Maybe this is kinda offtopic but IMO instead of using artifacts, we should put the resultd in a more visible place, like releases or something

I started using metrics after tldr-pages/tldr#12939 and it always was a trouble to find the artifact for me, so I always navigated to the issue and clicked the link.

@kbdharun
Copy link
Member

kbdharun commented Sep 3, 2024

I think designing a frontend site to display the statistics and also visualize the languages would work the best (we can push the current assets to releases, and get them on the site).

Or we can create a script/action to display this information in an issue and pin it in the main repo (similar to Renovate Dashboards, etc used by other FOSS projects).

@sebastiaanspeck
Copy link
Member Author

sebastiaanspeck commented Sep 7, 2024

I think designing a frontend site to display the statistics and also visualize the languages would work the best (we can push the current assets to releases, and get them on the site).

I checked, but we can only upload a maximum of 100 artifacts per GH Release. We could upload the metrics.zip, but that still requires the user to download it first. Edit: see #21 for a release-setup

Or we can create a script/action to display this information in an issue and pin it in the main repo (similar to Renovate Dashboards, etc used by other FOSS projects).

I like the idea of keeping things in GitHub. Since we have multiple languages, do we want to create 1 issue or 1 issue per language? To me, 1 issue per language is better.

The next discussion might be if we want to create the issues over here or in the main repo. It might create clutter for newcomers, although it are great good first issues. If we have this before Hacktoberfest, I think we can use the community to work away the big stack much quicker.

I do not know if we only want to create issues for CODEOWNERS? Those languages are the most maintained languages. Other languages do not seem to get that many updates.

An example could be:

### Missing and Outdated Pages for Arabic (AR)

**Description:**
This issue tracks the metrics in the Arabic (AR) translation of TLDR pages.

#### Summary:
- **Missing Alias Pages:** 327 ([See details](check-pages.ar/missing-ar-alias-pages.txt))
- **Outdated Pages Based on Command Count:** 3 ([See details below](#outdated-pages))
- **Missing Translated Pages:** 5045 ([See details](check-pages.ar/missing-translated-ar-pages.txt))

---

<details>
<summary>**Outdated Pages based on number of commands (3):**</summary>

- [clamav.md](https://github.com/tldr-pages/tldr/blob/main/pages.ar/common/clamav.md)
- [curl.md](https://github.com/tldr-pages/tldr/blob/main/pages.ar/common/curl.md)
- [wget.md](https://github.com/tldr-pages/tldr/blob/main/pages.ar/common/wget.md)

</details>

@kbdharun
Copy link
Member

kbdharun commented Sep 7, 2024

I checked, but we can only upload a maximum of 100 artifacts per GH Release. We could upload the metrics.zip, but that still requires the user to download it first. Edit: see #21 for a release-setup

I am not sure where you got the statistics from, but GitHub releases don't have a limit on the number of artifacts that can be uploaded/overwritten for a single release rather there is a size restriction of 2 GB for each artifact file.

I like the idea of keeping things in GitHub. Since we have multiple languages, do we want to create 1 issue or 1 issue per language? To me, 1 issue per language is better.

The next discussion might be if we want to create the issues over here or in the main repo. It might create clutter for newcomers, although it are great good first issues. If we have this before Hacktoberfest, I think we can use the community to work away the big stack much quicker.

I do not know if we only want to create issues for CODEOWNERS? Those languages are the most maintained languages. Other languages do not seem to get that many updates.

We can go with an approach like this i.e. open issues per language here on this repo and create an issue with an overall dashboard in the main repo and link to the issue here.

I think we should do this for all languages in tldr not just for ones with a CODEOWNER.

@kbdharun kbdharun added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Sep 7, 2024
@sebastiaanspeck
Copy link
Member Author

sebastiaanspeck commented Sep 7, 2024

I checked, but we can only upload a maximum of 100 artifacts per GH Release. We could upload the metrics.zip, but that still requires the user to download it first. Edit: see #21 for a release-setup

I am not sure where you got the statistics from, but GitHub releases don't have a limit on the number of artifacts that can be uploaded/overwritten for a single release rather there is a size restriction of 2 GB for each artifact file.

Ah, you're right. The action that we are using did not catch the check-pages*/ at first, but we are uploading the metrics.zip as well, since a release cannot contain folders, which would cause overwriting the debug.log constantly

I like the idea of keeping things in GitHub. Since we have multiple languages, do we want to create 1 issue or 1 issue per language? To me, 1 issue per language is better.

The next discussion might be if we want to create the issues over here or in the main repo. It might create clutter for newcomers, although it are great good first issues. If we have this before Hacktoberfest, I think we can use the community to work away the big stack much quicker.

I do not know if we only want to create issues for CODEOWNERS? Those languages are the most maintained languages. Other languages do not seem to get that many updates.

We can go with an approach like this i.e. open issues per language here on this repo and create an issue with an overall dashboard in the main repo and link to the issue here.

I think we should do this for all languages in tldr not just for ones with a CODEOWNER.

Great ideas! Sounds good to me

@sebastiaanspeck
Copy link
Member Author

See #127 for a first version. This will be updated with #26 automatically

@kbdharun
Copy link
Member

Great work @sebastiaanspeck, just went through all the dashboards. Btw, does it create a new issue when we add a language to the main repository?

@sebastiaanspeck
Copy link
Member Author

Great work @sebastiaanspeck, just went through all the dashboards. Btw, does it create a new issue when we add a language to the main repository?

Right now it does not create a new issue, but how it is implemented right now, that's fairly easy to do

@sebastiaanspeck
Copy link
Member Author

@kbdharun thank you for locking the Issues

@sebastiaanspeck
Copy link
Member Author

I tried to move #127 to tldr itself, but then I couldn't update it anymore. I now have introduced a symbolic-link issue: tldr-pages/tldr#13663 in tldr itself.

Is there anything for now we want to improve or can we close this issue?

@kbdharun
Copy link
Member

Is there anything for now we want to improve or can we close this issue?

We can close this issue, now that we have dashboards for each languages and the concerns has been addressed. Once again, thanks for taking your time to make this integration.

@kbdharun kbdharun added this to Roadmap Sep 17, 2024
@github-project-automation github-project-automation bot moved this to Todo in Roadmap Sep 17, 2024
@kbdharun kbdharun moved this from Todo to Done in Roadmap Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants