Skip to content

Commit 044c4d7

Browse files
Merge remote-tracking branch 'origin/master' into fix/clarification-rest-ocs
2 parents 34756e2 + 5a794e6 commit 044c4d7

1,194 files changed

Lines changed: 46047 additions & 90149 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.devcontainer/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ USER root
66
RUN export DEBIAN_FRONTEND=noninteractive \
77
&& apt-get update \
88
&& apt-get -y install --no-install-recommends \
9-
curl gnupg2 git nano make graphviz imagemagick inkscape sass unzip wget php-cli npm latexmk texlive-latex-extra tex-gyre \
9+
curl gnupg2 git nano make graphviz imagemagick inkscape sass unzip wget php-cli npm latexmk texlive-latex-extra tex-gyre texlive-xetex \
1010
&& wget https://getcomposer.org/installer -qO /tmp/composer-setup.php \
1111
&& php /tmp/composer-setup.php \
1212
&& mv composer.phar /usr/local/bin/composer \

.github/workflows/check-occ-command.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
name: Check occ command syntax
1111
runs-on: ubuntu-latest
1212
steps:
13-
- uses: actions/checkout@v4
13+
- uses: actions/checkout@v5
1414

1515
- name: Run script
1616
run: |

.github/workflows/codespell.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
runs-on: self-hosted
1313
steps:
1414
- name: Check out code
15-
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
15+
uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493 # v4.2.2
1616
with:
1717
persist-credentials: false
1818

.github/workflows/generate_catalog_templates.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ jobs:
1313
runs-on: ubuntu-latest
1414
steps:
1515
- name: Checkout repository
16-
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
16+
uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493 # v4.2.2
1717
with:
1818
persist-credentials: false
1919

20-
- uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
20+
- uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
2121
with:
2222
python-version: '3.13'
2323

.github/workflows/openapi.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ jobs:
1515

1616
steps:
1717
- name: Checkout
18-
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
18+
uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493 # v4.2.2
1919
with:
2020
submodules: true
2121

2222
- name: Set up php
23-
uses: shivammathur/setup-php@cf4cade2721270509d5b1c766ab3549210a39a2a # v2
23+
uses: shivammathur/setup-php@ec406be512d7077f68eed36e63f4d91bc006edc4 # v2
2424
with:
2525
php-version: '8.1'
2626
# https://docs.nextcloud.com/server/stable/admin_manual/installation/source_installation.html#prerequisites-for-manual-installation

.github/workflows/sphinxbuild.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ jobs:
1111
user_manual:
1212
runs-on: ubuntu-latest
1313
steps:
14-
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
15-
- uses: actions/setup-python@v5
14+
- uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493
15+
- uses: actions/setup-python@v6
1616
with:
1717
python-version: '3.10'
1818
cache: 'pip'
@@ -32,8 +32,8 @@ jobs:
3232
user_manual-en:
3333
runs-on: ubuntu-latest
3434
steps:
35-
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
36-
- uses: actions/setup-python@v5
35+
- uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493
36+
- uses: actions/setup-python@v6
3737
with:
3838
python-version: '3.10'
3939
cache: 'pip'
@@ -45,8 +45,8 @@ jobs:
4545
developer_manual:
4646
runs-on: ubuntu-latest
4747
steps:
48-
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
49-
- uses: actions/setup-python@v5
48+
- uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493
49+
- uses: actions/setup-python@v6
5050
with:
5151
python-version: '3.10'
5252
cache: 'pip'
@@ -66,8 +66,8 @@ jobs:
6666
admin_manual:
6767
runs-on: ubuntu-latest
6868
steps:
69-
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
70-
- uses: actions/setup-python@v5
69+
- uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493
70+
- uses: actions/setup-python@v6
7171
with:
7272
python-version: '3.10'
7373
cache: 'pip'

README.rst

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@ To edit a document, you can edit the .rst files on your local system, or work
6969
directly on GitHub. The latter is only suitable for small fixes and improvements
7070
because substantial editing efforts can better be controlled on your local PC.
7171

72+
.. tip::
73+
If you're getting to know our documentation syntax, `give Documatt Snippets
74+
<https://snippets.documatt.com/>`_ a try. This online editor is a great way
75+
to practice with reStructuredText and Sphinx, and it provides a more accurate
76+
preview of your work than GitHub does.
77+
7278
The best way is to install a complete Sphinx build environment and work on your
7379
local PC. You will be able to make your own local builds, which is the fastest
7480
and best way to preview for errors. Sphinx will report syntax errors, missing
@@ -99,7 +105,7 @@ which if you have privacy enabled will be github.username@users.noreply.github.c
99105
Translations
100106
------------
101107

102-
`Help translate the documentation <https://www.transifex.com/nextcloud/nextcloud-user-documentation/dashboard/>`_.
108+
`Help translate the documentation <https://explore.transifex.com/nextcloud/nextcloud-user-documentation/>`_.
103109

104110
For developers that want to ease the translation process, please read `this documentation <https://docs.transifex.com/integrations/sphinx-doc>`_.
105111

@@ -143,6 +149,17 @@ Using venv
143149
5. Now you can use ``make ...`` to build all the stuff - for example ``make html`` to build the HTML flavor of all manuals
144150
The build assets will be put into the individual documentation subdirectories like ``developer_manual/_build/html/com``
145151

152+
Building translated versions
153+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
154+
155+
Only available in user_manual:
156+
157+
1. Build the english version as described above before
158+
2. Create translation files: ``../build/change_file_extension.sh``
159+
3. Create German (``de``) version: ``make html-lang-de``
160+
4. Find the HTML files in ``_build/html/de/index.html``
161+
5. Before building another language you have to delete the complete ``_build`` directory
162+
146163
Autobuilding
147164
^^^^^^^^^^^^
148165

@@ -157,6 +174,27 @@ When editing the documentation installing ``sphinx-autobuild`` though pip can be
157174
Building PDF
158175
============
159176

177+
Building inside docker
178+
^^^^^^^^^^^^^^^^^^^^^^
179+
180+
1. Create a docker:: ``docker run --platform linux/amd64 --volume .:/docs --interactive --tty --name nextcloud-docs ghcr.io/nextcloud/continuous-integration-documentation:documentation-15 bash``
181+
2. Change into the documentation directory: ``cd /docs``
182+
3. Only once: Create a venv: ``python -m venv venv``
183+
4. Activate the environment: ``source venv/bin/activate``
184+
5. Install the dependencies ``pip install -r requirements.txt``
185+
6. Change into the documentation of choice (admin, developer, user): ``cd /docs/user_manual``
186+
7. To build the English version: ``make latexpdf``
187+
8. To build the translated version (only available in user_manual):
188+
1. Create translation files: ``../build/change_file_extension.sh``
189+
2. Create German (``de``) version: ``make latexpdf-lang-de``
190+
3. Find the file in ``_build/latex/Nextcloud_User_Manual.pdf``
191+
4. Before building another language you have to delete the complete ``_build`` directory
192+
193+
Building locally
194+
^^^^^^^^^^^^^^^^
195+
196+
.. note:: Because of the many dependencies LaTeX and the other tools bring in, it is not recommended to install the tools locally.
197+
160198
1. Follow instructions for "Building HTML" above
161199
2. Install ``latexmk`` and ``texlive-latex-extra`` - https://pipenv.readthedocs.io/en/latest/
162200
3. Create a Python environment (typically inside this repository): ``pipenv --python 3.9``

admin_manual/_templates/versions.html

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,22 @@
22
{# Add rst-badge after rst-versions for small badge style. #}
33
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
44
<span class="rst-current-version" data-toggle="rst-current-version">
5-
<span class="fa fa-book"> Read the Docs</span>
6-
v: {{ current_version }}
5+
☁️ {{ current_version }}
76
<span class="fa fa-caret-down"></span>
87
</span>
98
<div class="rst-other-versions">
109
<dl>
11-
<dt>{{ _('Versions') }}</dt>
12-
{% for slug, url in versions %}
13-
<dd><a href="{{ url }}">{{ slug }}</a></dd>
10+
<dt>☁️ {{ _('Versions') }}</dt>
11+
{% for slug, url in versions|reverse %}
12+
<dd style="width: 32%">
13+
<a href="{{ url }}"
14+
{% if current_version == slug %}
15+
style="color: var(--dark-link-color);"
16+
{% endif %}
17+
>
18+
{{ slug }}
19+
</a>
20+
</dd>
1421
{% endfor %}
1522
</dl>
1623
</div>

admin_manual/ai/app_assistant.rst

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,8 @@ These apps currently implement the following Assistant Tasks:
7474
* *Summarize* (Tested with OpenAI GPT-3.5 and Llama 3.1 8B)
7575
* *Generate headline* (Tested with OpenAI GPT-3.5 and Llama 3.1 8B)
7676
* *Extract topics* (Tested with OpenAI GPT-3.5 and Llama 3.1 8B)
77-
78-
Additionally, *integration_openai* also implements the following Assistant Tasks:
79-
80-
* *Context write* (Tested with OpenAI GPT-3.5)
81-
* *Reformulate text* (Tested with OpenAI GPT-3.5)
77+
* *Context write* (Tested with OpenAI GPT-3.5 and Llama 3.1 8B)
78+
* *Reformulate text* (Tested with OpenAI GPT-3.5 and Llama 3.1 8B)
8279

8380
These tasks may work with other models, but we can give no guarantees.
8481

@@ -98,7 +95,7 @@ In order to make use of our special Context Chat feature, offering in-context in
9895

9996
* :ref:`context_chat + context_chat_backend<ai-app-context_chat>` - (Customer support available upon request)
10097

101-
You will also need a text processing provider as specified above (ie. llm2 or integration_openai).
98+
You will also need a text processing provider as specified above (ie. llm2, integration_openai or integration_watsonx).
10299

103100
Context Agent
104101
~~~~~~~~~~~~~
@@ -117,6 +114,7 @@ Text-To-Speech
117114
In order to make use of Text-To-Speech, you will need an app that provides a Text-To-Speech backend:
118115

119116
* *integration_openai* - Integrates with the OpenAI API to provide AI functionality from OpenAI servers (Customer support available upon request; see :ref:`AI as a Service<ai-ai_as_a_service>`)
117+
* *text2speech_kokoro* - Runs a local model
120118

121119
Configuration
122120
-------------
@@ -195,6 +193,14 @@ Set 1 to enable and 0 to disable an implemented task type.
195193
196194
shows statistics for all task processing Tasks.
197195

196+
5. Clean-up old tasks
197+
198+
.. code-block::
199+
200+
occ taskprocessing:task:cleanup
201+
202+
delete tasks that are older than this number of seconds, defaults to 4 months.
203+
198204
Image storage
199205
~~~~~~~~~~~~~
200206

0 commit comments

Comments
 (0)