-
-
Notifications
You must be signed in to change notification settings - Fork 5
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
Comments
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. |
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). |
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 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 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> |
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.
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. |
Ah, you're right. The action that we are using did not catch the
Great ideas! Sounds good to me |
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 |
@kbdharun thank you for locking the Issues |
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? |
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. |
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
The text was updated successfully, but these errors were encountered: