Move translation and documentation contributor pages up a level in contributor sidebar#524
Move translation and documentation contributor pages up a level in contributor sidebar#524SoryRawyer wants to merge 3 commits intoOpenRefine:masterfrom
Conversation
Moves translation and documentation contributor roles into sidebar Also renames the sidebar labels from translation and documentation contributions to match the naming for the other contribution types.
✅ Deploy Preview for openrefine-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| id: documentation-contributions | ||
| title: Documentation contributions | ||
| sidebar_label: Documentation contributions | ||
| sidebar_label: Contributing documentation |
There was a problem hiding this comment.
I agree with the comment in the original issue that it would be preferable to have all four sidebar entries have consistent wording. Was it intentional that this wasn't done?
There was a problem hiding this comment.
Ah no, just an embarrassing oversight on my part. I'll update that along with the link to the README.
| ```sh | ||
| yarn build | ||
| ``` | ||
| The repository README contains instructions for developing the project locally. |
There was a problem hiding this comment.
Perhaps link this to the README?
| The repository README contains instructions for developing the project locally. | |
| The repository [README](https://github.com/OpenRefine/openrefine.org/blob/master/README.md) contains instructions for developing the project locally. |
| id: translating-ui | ||
| title: Translate OpenRefine's interface | ||
| sidebar_label: Translate OpenRefine's interface | ||
| sidebar_label: Contributing translations |
There was a problem hiding this comment.
Same comment as above about consistent wording.
- adds a link to the site README in the documentation page - renames the documentation and translation sidebar items to be consistent with the other contribution types
|
Thanks for the review! Here is a screenshot with the sidebar text updated: |
magdmartin
left a comment
magdmartin
left a comment
There was a problem hiding this comment.
Overall, I think this is a step in the right direction and can help prompt future contributors to improve the documentation regarding those two roles.
| id: documentation-contributions | ||
| title: Documentation contributions | ||
| sidebar_label: Documentation contributions | ||
| sidebar_label: Contributing as a documenter |
There was a problem hiding this comment.
We use the term technical writer on the community page it may be good to align the term. I am OK with both
| id: translating-ui | ||
| title: Translate OpenRefine's interface | ||
| sidebar_label: Translate OpenRefine's interface | ||
| sidebar_label: Contributing as a translator |
There was a problem hiding this comment.
As it currently stands, the content seems to target developers, focusing on how localization is implemented in the code. Do we want to exclude this from the developer documentation? As a translator, I would expect documentation to explain how to use Weblate or guidelines on how we want translation to be done so it is consistent across languages (which, as far as I know, does not exist).
There was a problem hiding this comment.
That's a great point. I'm not able to provide more information on Weblate so I opened a follow-up issue to add details on the integration.
As for the localization code, I think this is probably the best place for it. I'd either look in the backend architecture guide or this document if I were looking for details on localization/internationalization. Either way, I think moving that to a different section would be best left for a follow-up task as well.
|
I updated the documentation sidebar item to say "technical writer". Here is an updated screenshot of the sidebar: |
3 participants
fixes #523
Moves translation and documentation pages into the sidebar under "Contributing to OpenRefine" so that they align with the code and design contribution types. This PR also renames the sidebar labels from translation and documentation contributions to match the naming for the other contribution types. Finally, the documentation page is updated to remove stale documentation and point to the repo README to keep documentation in one place.