174 lines
6.2 KiB
Plaintext
174 lines
6.2 KiB
Plaintext
# SOME DESCRIPTIVE TITLE.
|
|
# Copyright (C) 2023, The Funkwhale Collective
|
|
# This file is distributed under the same license as the funkwhale package.
|
|
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
|
|
#
|
|
#, fuzzy
|
|
msgid ""
|
|
msgstr ""
|
|
"Project-Id-Version: funkwhale 1.2.10\n"
|
|
"Report-Msgid-Bugs-To: \n"
|
|
"POT-Creation-Date: 2023-03-24 18:14+0100\n"
|
|
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
|
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
|
"Language-Team: LANGUAGE <LL@li.org>\n"
|
|
"MIME-Version: 1.0\n"
|
|
"Content-Type: text/plain; charset=UTF-8\n"
|
|
"Content-Transfer-Encoding: 8bit\n"
|
|
|
|
#: ../../contributor/documentation.md:1
|
|
msgid "Document Funkwhale"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:4
|
|
msgid "If you notice something missing in our documentation but don't feel confident contributing, submit a request [in our forum](https://forum.funkwhale.audio/t/documentation)."
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:7
|
|
msgid "We try to document Funkwhale as thoroughly as possible to make it easy for users, admins, developers, and contributors to understand how everything works."
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:13
|
|
msgid "Requirements"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:15
|
|
msgid "To work on Funkwhale's documentation, you need the following:"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:17
|
|
msgid "[Git](https://git-scm.com): our version control system"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:18
|
|
msgid "[Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/): used to run our development environment"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:19
|
|
msgid "A text editor of your choice"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:21
|
|
msgid "Tooling"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:23
|
|
msgid "We use [Sphinx](https://www.sphinx-doc.org/) to generate our documentation. Sphinx provides excellent tooling for documenting Python projects. We write documentation in Markdown using the [MyST parser](https://myst-parser.readthedocs.io/en/latest/) to access Sphinx's features."
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:25
|
|
msgid "All documentation in Funkwhale is stored in the [main Funkwhale Git repository](https://dev.funkwhale.audio/funkwhale/funkwhale/-/tree/develop/docs)."
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:27
|
|
msgid "Style guide"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:29
|
|
msgid "We broadly follow the [Microsoft writing style guide](https://learn.microsoft.com/en-us/style-guide/welcome/) for language and tone. You should aim to keep your language simple and clear enough for readers of all levels. You can use a free tool like [Hemingway](https://hemingwayapp.com) to check the complexity of your sentences."
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:31
|
|
msgid "Here are some basic rules to follow:"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:33
|
|
msgid "Write in American English"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:34
|
|
msgid "Always use sentence casing for headers. For example: \"Contribute to Funkwhale documentation\" rather than \"Contribute To Funkwhale Documentation\""
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:35
|
|
msgid "Use contractions such as \"don't\" and \"can't\" to make your writing feel conversational. Only use the full words if you're trying to emphasize something"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:37
|
|
msgid "Local setup"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:39
|
|
msgid "We provide a docker container for our documentation to make it easy to work on docs with a real-time preview. Once you install [Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/), do the following to get a live preview:"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:41
|
|
msgid "Create a dummy `.env` file"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:47
|
|
msgid "Create a dummy federation network"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:53
|
|
msgid "Build the container"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:59
|
|
msgid "Run the container"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:65
|
|
msgid "A real-time preview of the documentation is available on `http://0.0.0.1:8001`"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:67
|
|
msgid "Redirects"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:69
|
|
msgid "If you move content to a new location, you need to set up a redirect. This ensures that any bookmarks or links posted before the change still take the user where they expect to go."
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:71
|
|
msgid "All redirects are stored in a {file}`redirects.txt` file. This is a simple text file containing one redirect per line. Each line contains the old URL and new URL as relative URLs."
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:73
|
|
msgid "In this example, the `architecture.html` file redirects to `https://docs.funkwhale.audio/developers/architecture.html`."
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:79
|
|
msgid "Contribution flow"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:81
|
|
msgid "Here's an example of the typical workflow for creating documentation:"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:83
|
|
msgid "[Create a fork](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html) of the Funkwhale codebase"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:84
|
|
msgid "Create a new branch for your documentation. In this example `my-branch-name` is the name of the branch"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:90
|
|
msgid "Make your changes and verify them by running the [Docker container](#local-setup)"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:91
|
|
msgid "Add [redirects](#redirects) if required"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:92
|
|
msgid "Add a [changelog fragment](../developer/workflows/changelog.md)"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:93
|
|
msgid "Add your changed files to a commit"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:100
|
|
msgid "Create a commit with a meaningful commit message"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:106
|
|
msgid "Push your changes to your fork"
|
|
msgstr ""
|
|
|
|
#: ../../contributor/documentation.md:112
|
|
msgid "Create a merge request in the [main Funkwhale repository](https://dev.funkwhale.audio/funkwhale/funkwhale)"
|
|
msgstr ""
|