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

Add file format examples to the documentation #9078

Closed
nijel opened this issue Apr 13, 2023 · 5 comments · Fixed by #10309
Closed

Add file format examples to the documentation #9078

nijel opened this issue Apr 13, 2023 · 5 comments · Fixed by #10309
Labels
documentation Improvements or additions to the documentation. enhancement Adding or requesting a new feature. good first issue Opportunity for newcoming contributors. hacktoberfest This is suitable for Hacktoberfest. Don’t try to spam. help wanted Extra attention is needed.
Milestone

Comments

@nijel
Copy link
Member

nijel commented Apr 13, 2023

Describe the problem

Some documentation of file formats include examples, but most not. It should be improved.

Describe the solution you'd like

Almost each file format page should include Example files section showing an example of such file (the exception here probably will be binary formats like Excel or IDML).

Describe alternatives you've considered

No response

Screenshots

No response

Additional context

https://docs.weblate.org/en/latest/formats/json.html already does include this.

For many of formats, the example files can be found in the test suite, so it can be included like in JSON docs: https://github.com/WeblateOrg/weblate/blob/main/docs/formats/json.rst

@nijel nijel added enhancement Adding or requesting a new feature. documentation Improvements or additions to the documentation. hacktoberfest This is suitable for Hacktoberfest. Don’t try to spam. help wanted Extra attention is needed. good first issue Opportunity for newcoming contributors. labels Apr 13, 2023
@github-actions
Copy link

This issue seems to be a good fit for newbie contributors. You are welcome to contribute to Weblate! Don't hesitate to ask any questions you would have while implementing this.

You can learn about how to get started in our contributors documentation.

@xvisierra xvisierra mentioned this issue May 16, 2023
1 task
@pernelkanic
Copy link

can i take up this issue?

@nijel
Copy link
Member Author

nijel commented Oct 9, 2023

Yes, any contribution is welcome.

@pernelkanic
Copy link

Can I get a brief on what must be done?

@nijel nijel added this to the 5.2 milestone Nov 1, 2023
Copy link

github-actions bot commented Nov 1, 2023

Thank you for your report; the issue you have reported has just been fixed.

  • In case you see a problem with the fix, please comment on this issue.
  • In case you see a similar problem, please open a separate issue.
  • If you are happy with the outcome, don’t hesitate to support Weblate by making a donation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to the documentation. enhancement Adding or requesting a new feature. good first issue Opportunity for newcoming contributors. hacktoberfest This is suitable for Hacktoberfest. Don’t try to spam. help wanted Extra attention is needed.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants