weblate/docs/index.rst
2025-01-22 09:16:35 +01:00

170 lines
3.5 KiB
ReStructuredText

Weblate Documentation
=====================
.. only:: not i18n
.. note::
Weblate's documentation is available in various languages and versions.
Expand the "Read the Docs" panel at the bottom of the sidebar to see the
list.
.. only:: i18n
.. note::
This documentation is translated from the `original English one
<https://docs.weblate.org/en/latest/>`_ by community members on
`Hosted Weblate <https://hosted.weblate.org/projects/weblate/documentation/>`_.
Depending on the translation effort's completion level, you may find
paragraphs or whole pages which are still in English. You can help the
community by providing new translations or reviewing existing ones on
Weblate.
Welcome to the official documentation of `Weblate <https://weblate.org>`_, the
libre software web-based continuous localization system.
The table of contents in the sidebar should let you easily access the documentation
for your topic of interest. You can also use the search function in the top-left corner.
First time here?
-----------------
Read the :doc:`user/basic` to get an overview of what Weblate does.
Joining a translation project
------------------------------
If you would like to contribute to a project as a translator, read about :doc:`user/translating`.
Starting a translation project
-------------------------------
For starting your own project on our cloud service Hosted Weblate, refer to :doc:`admin/projects`.
For self-hosting your own Weblate clone, read our :doc:`admin/install`.
FAQ
----
Check our :doc:`faq`.
Community
----------
Learn more about :ref:`contributing`.
.. toctree::
:caption: User docs
:maxdepth: 1
:hidden:
user/basic
user/profile
user/translating
user/files
user/glossary
user/checks
user/search
workflows
faq
vcs
api
wlc
python
.. toctree::
:caption: Application developer guide
:maxdepth: 1
:hidden:
devel/starting
devel/integration
devel/gettext
devel/sphinx
devel/html
devel/third-party
devel/alerts
devel/community
devel/translations
devel/review
devel/share
devel/reporting
.. toctree::
:caption: File formats
:maxdepth: 1
:glob:
:hidden:
formats
formats/*
.. toctree::
:caption: Administrator docs
:maxdepth: 1
:hidden:
admin/install
admin/deployments
admin/upgrade
admin/backup
admin/auth
admin/access
admin/projects
admin/languages
admin/continuous
admin/licensing
admin/translating
admin/checks
admin/machine
admin/addons
admin/memory
admin/config
admin/sample
admin/management
admin/announcements
admin/componentlists
admin/optionals
admin/customize
admin/admin
admin/support
legal
.. toctree::
:caption: Contributor docs
:maxdepth: 1
:hidden:
contributing/index
contributing/communication
contributing/start
contributing/code
contributing/debugging
contributing/internals
contributing/addons
contributing/frontend
contributing/issues
contributing/tests
contributing/schemas
contributing/release
contributing/security
contributing/modules
contributing/about
contributing/license
contributing/trademark
.. toctree::
:caption: Change history
:maxdepth: 1
:hidden:
changes
changes/v4
changes/v3
changes/v2
changes/v1
changes/v0
.. toctree::
:caption: Indices and tables
:hidden:
genindex
modindex