forgejo/docs
31
58
Fork
You've already forked docs
249

Docs localisation #14

Open
opened 2023年08月16日 22:07:00 +02:00 by caesar · 5 comments
Member
Copy link

It would be great to localise the documentation into different languages.
This is probably quite a long-term goal. The hardest part will be finding localisation teams for each locale.
This issue serves as a place to gather ideas on the subject.

Related: forgejo/website#4

It would be great to localise the documentation into different languages. This is probably quite a long-term goal. The hardest part will be finding localisation teams for each locale. This issue serves as a place to gather ideas on the subject. Related: forgejo/website#4

IMHO this is where having a framework dedicated to documentation might help. I don't know if there is one that is natively supporting weblate?

IMHO this is where having a framework dedicated to documentation might help. I don't know if there is one that is natively supporting weblate?
Author
Member
Copy link

Starlight supports localisation. I proposed adopting it for our docs, however on following up it will be a little more complicated than I initially thought to make it work at a subpath (forgejo.org/docs/) instead of a subdomain (docs.forgejo.org). But I will have another look at it, and other options, when I get a chance.

Starlight [supports localisation](https://starlight.astro.build/guides/i18n/). I [proposed adopting it](https://codeberg.org/forgejo/website/issues/332) for our docs, however on following up it will be a little more complicated than I initially thought to make it work at a subpath (`forgejo.org/docs/`) instead of a subdomain (`docs.forgejo.org`). But I will have another look at it, and other options, when I get a chance.

Thanks for the link, I missed it. Having sub-domains instead of sub-path is not too much of a problem, IMHO.

Thanks for the link, I missed it. Having sub-domains instead of sub-path is not too much of a problem, IMHO.

For the record Weblate is well integrated with Sphinx because both are python based https://docs.weblate.org/en/latest/devel/sphinx.html

Not very useful in the context of Forgejo

For the record Weblate is well integrated with Sphinx because both are python based https://docs.weblate.org/en/latest/devel/sphinx.html Not very useful in the context of Forgejo
Author
Member
Copy link

Having sub-domains instead of sub-path is not too much of a problem, IMHO.

Agreed. It would mean the docs site was entirely separate from the rest of the site architecturally, which would have both pros and cons... better discussed on forgejo/website#332.

Weblate is well integrated with Sphinx

I'd prefer to more or less stick with the stack we have for the site rather than switch to something totally different like Sphinx, unless there was a compelling reason. That's why I like the idea of Starlight if we can make it work, because it's based on Astro and maintained by the same people behind Astro itself.

> Having sub-domains instead of sub-path is not too much of a problem, IMHO. Agreed. It would mean the docs site was entirely separate from the rest of the site architecturally, which would have both pros and cons... better discussed on forgejo/website#332. > Weblate is well integrated with Sphinx I'd prefer to more or less stick with the stack we have for the site rather than switch to something totally different like Sphinx, unless there was a compelling reason. That's why I like the idea of Starlight if we can make it work, because it's based on Astro and maintained by the same people behind Astro itself.
Sign in to join this conversation.
No Branch/Tag specified
next
bp-v16.0-262971a
bp-v15.0-262971a
v16.0
v15.0
v11.0
bp-v15.0-c7697f2
actions-remove-non-existing-strategy-options
v14.0
v13.0
v12.0
v7.0
v10.0
v9.0
v8.0
v1.21
v1.20
v1.19
v13.0.0-dev
Labels
Clear labels
404
Broken links or missing content
backport/v1.19
Changes which should be backported to the v1.19 docs

Archived

backport/v1.20
Changes which should be backported to the v1.20 docs

Archived

backport/v1.21
Changes which should be backported to the v1.21 docs

Archived

backport/v10.0
Automated backport to v10.0

Archived

backport/v11.0
Automated backport to v11.0
backport/v12.0
Automated backport to v12.0

Archived

backport/v13.0
Automated backport to v13.0

Archived

backport/v14.0
Automated backport to v14.0

Archived

backport/v15.0
Automated backport to v15.0
backport/v16.0
Automated backport to v16.0
backport/v7.0
Automated backport to the v7.0 docs

Archived

backport/v8.0
Automated backport to the v8.0 docs

Archived

backport/v9.0
Automated backport to the v9.0 docs

Archived

good first issue
This issue is suitable for "drive-by contributors" wanting to contribute for the first time, and fixing it should be straightforward.
meta
Tooling and processes for maintaining the docs
new docs
Content to be added to the documentation

Archived

User research - Accessibility
Requires input about accessibility features, likely involves user testing.
User research - Blocked
Do not pick as-is! We are happy if you can help, but please coordinate with ongoing redesign in this area.
User research - Community
Community features, such as discovering other people's work or otherwise feeling welcome on a Forgejo instance.
User research - Config (instance)
Instance-wide configuration, authentication and other admin-only needs.
User research - Errors
How to deal with errors in the application and write helpful error messages.
User research - Filters
How filter and search is being worked with.
User research - Future backlog
The issue might be inspiring for future design work.
User research - Git workflow
AGit, fork-based and new Git workflow, PR creation etc
User research - Labels
Active research about Labels
User research - Moderation
Moderation Featuers for Admins are undergoing active User Research
User research - Needs input
Use this label to let the User Research team know their input is requested.
User research - Notifications/Dashboard
Research on how users should know what to do next.
User research - Rendering
Text rendering, markup languages etc
User research - Repo creation
Active research about the New Repo dialog.
User research - Repo units
The repo sections, disabling them and the "Add more" button.
User research - Security
User research - Settings (in-app)
How to structure in-app settings in the future?
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
forgejo/docs#14
Reference in a new issue
forgejo/docs
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?