Skip to content

Commit fb85ca6

Browse files
Copilotskjnldsv
Copilot
and
skjnldsv
authored
Merge remote-tracking branch 'origin/master' into bugfix/contacts-subscriptions
# Conflicts: # admin_manual/installation/apps_supported.rst Co-authored-by: skjnldsv <14975046+skjnldsv@users.noreply.github.com>
2 parents cb62250 + 194c61f commit fb85ca6

2,453 files changed

Lines changed: 181364 additions & 99117 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.

‎.codespellignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
hasTable
2+
jus
3+
nin
4+
SME
5+
te

‎.codespellrc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[codespell]
2+
skip = ./build/*,**/_build/*,*.pot,conf.py,./static/*,./admin_manual/configuration_server/config_sample_php_parameters.rst,./_shared_assets/*,./COPYING
3+
ignore-words = .codespellignore
4+
check-filenames = true

‎.devcontainer/Dockerfile‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
1-
FROM python:3.9 as final
1+
FROM ubuntu:24.04
2+
3+
LABEL org.opencontainers.image.source="https://github.com/nextcloud/documentation"
4+
LABEL org.opencontainers.image.description="Sphinx build environment for Nextcloud documentation"
5+
LABEL org.opencontainers.image.licenses="AGPL-3.0"
26

37
USER root
48

59
# Add dev tools needed for building
610
RUN export DEBIAN_FRONTEND=noninteractive \
711
&& apt-get update \
812
&& 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 \
10-
&& wget https://getcomposer.org/installer -qO /tmp/composer-setup.php \
11-
&& php /tmp/composer-setup.php \
12-
&& mv composer.phar /usr/local/bin/composer \
13-
&& npm install svgexport -g \
14-
&& rm -f /tmp/composer-setup.php \
15-
&& rm -rf /var/lib/apt/lists/*
13+
ca-certificates curl gnupg2 git lsb-release nano make \
14+
unzip wget \
15+
python3 python3-pip python3-venv \
16+
latexmk texlive-fonts-extra texlive-fonts-extra-links texlive-fonts-recommended \
17+
texlive-latex-extra texlive-latex-recommended tex-gyre texlive-xetex xindy \
18+
&& mktexlsr \
19+
&& rm -rf /var/lib/apt/lists/*
20+
21+
# Allow pip to install packages system-wide inside the container when running
22+
# as root (avoids PEP 668 "externally managed environment" error)
23+
RUN printf '[global]\nbreak-system-packages = true\n' > /etc/pip.conf

‎.github/CODEOWNERS‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
/*/groupware/ @ChristophWurst
2-
/*/groupware/calendar.rst @miaulalala
3-
/*/groupware/contacts.rst @hamza221
4-
/*/groupware/mail.rst @GretaD
1+
/*/groupware/calendar.rst @SebastianKrupinski @st3iny @tcitworld
2+
/*/groupware/contacts.rst @GVodyanov @hamza221 @SebastianKrupinski
3+
/*/groupware/mail.rst @ChristophWurst @GretaD @kesselb
54
/*/security.rst @nickvergessen
65
/admin_manual/configuration_database @nickvergessen
76
/admin_manual/file_workflows @nickvergessen
87
/developer_manual/client_apis/OCS/ocs-status-api.rst @Antreesy @nickvergessen
9-
/developer_manual/digging_deeper/groupware/ @ChristophWurst
10-
/developer_manual/digging_deeper/groupware/calendar.rst @miaulalala
8+
/developer_manual/digging_deeper/groupware/calendar.rst @SebastianKrupinski @st3iny @tcitworld
119
/developer_manual/digging_deeper/talk.rst @nickvergessen
1210
/user_manual/talk/ @Antreesy @DorraJaouad @nickvergessen
11+
12+
# Auto build actions
13+
.github/workflows/sphinxbuild.yml @skjnldsv
14+
.github/workflows/generate-top-index.yml @skjnldsv

‎.github/ISSUE_TEMPLATE/doc-issue.yml‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: Documentation improvement
2+
description: Suggest an improvement or report a mistake in the documentation.
3+
labels:
4+
- 0. Needs triage
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
#### Thank you for helping improve our documentation!
10+
All contributions - whether large or small - help make Nextcloud better and easier to use.
11+
12+
There is always room for improvement!
13+
---
14+
💡 **Tip:** Make sure you're looking at the latest version of the docs linked from [https://docs.nextcloud.com/](https://docs.nextcloud.com/).
15+
- type: checkboxes
16+
id: prechecks
17+
attributes:
18+
label: Before You Submit
19+
options:
20+
- label: I have checked for existing issues and pull requests related to my suggestion.
21+
- label: I have posted on the [Nextcloud Community Help Forum](https://help.nextcloud.com) if my suggestion is a troubleshooting scenario or I'm unsure about the solution.
22+
- type: dropdown
23+
id: type
24+
attributes:
25+
label: Type of Suggestion
26+
description: Please select the type that best fits your suggestion.
27+
options:
28+
- Reporting a mistake
29+
- Suggesting an improvement
30+
- Proposing new documentation content
31+
- Other
32+
multiple: true
33+
- type: input
34+
id: links
35+
attributes:
36+
label: Relevant Documentation Links
37+
description: Add URLs of relevant documentation pages here.
38+
placeholder: https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/
39+
- type: input
40+
id: summary
41+
attributes:
42+
label: Summary
43+
description: In one sentence, summarize your suggestion or report.
44+
placeholder: Write your summary here.
45+
- type: textarea
46+
id: details
47+
attributes:
48+
label: Details
49+
description: |
50+
Describe your suggestion or idea in detail. If reporting a mistake, include steps to reproduce or context.
51+
Example: My amazing idea is [...]
52+
placeholder: Describe your idea or report in detail.
53+
- type: textarea
54+
id: notes
55+
attributes:
56+
label: Additional Notes
57+
description: Any extra information, context, or follow-up links (like forum discussions).
58+
placeholder: Add any additional notes here.
59+
- type: markdown
60+
attributes:
61+
value: |
62+
---
63+
#### Project Guidance
64+
65+
- Please be patient: this is a large open source project overseen by a mix of volunteers and non-volunteers, and everyone is ultimately busy.
66+
- If your suggestion is a troubleshooting scenario or something you're not 100% certain about, please post for feedback on the [Nextcloud Community Help Forum](https://help.nextcloud.com) first.
67+
- Afterwards, return here to share your experience and help improve the documentation for clarity, etc. (and link back to the forum discussion in your report!)
68+
69+
#### Pro Tip: Want to help even more?
70+
71+
- Look for areas where you can assist - even seemingly unrelated areas - as doing so frees up resources for your favorite topics and ideas.
72+
- Submit a proposed change that addresses your issue as a pull request.
73+
- Participate in discussions on other unresolved [submitted ideas ("issues")](https://github.com/nextcloud/documentation/issues) to help move them forward.
74+
- Post a comment or review on someone else's [proposed change ("pull request")](https://github.com/nextcloud/documentation/pulls) to help move it along.
75+
76+
---
77+
Thank you for taking the time to help us make Nextcloud documentation better!

‎.github/ISSUE_TEMPLATE/improvement_suggestion.md‎

Lines changed: 0 additions & 32 deletions
This file was deleted.

‎.github/dependabot.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,22 @@ updates:
66
interval: weekly
77
time: "06:00"
88
open-pull-requests-limit: 10
9+
cooldown:
10+
default-days: 10
911
- package-ecosystem: "pip"
1012
directory: "/"
1113
schedule:
1214
interval: "weekly"
1315
time: "06:00"
1416
target-branch: master
1517
open-pull-requests-limit: 10
18+
cooldown:
19+
default-days: 10
20+
- package-ecosystem: "docker"
21+
directory: "/.devcontainer"
22+
schedule:
23+
interval: "weekly"
24+
time: "06:00"
25+
open-pull-requests-limit: 10
26+
cooldown:
27+
default-days: 10

‎.github/labeler.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
2+
# SPDX-License-Identifier: MIT
3+
4+
"manual: admin":
5+
- changed-files:
6+
- any-glob-to-any-file: "admin_manual/**"
7+
8+
"manual: developer":
9+
- changed-files:
10+
- any-glob-to-any-file: "developer_manual/**"
11+
12+
"manual: user":
13+
- changed-files:
14+
- any-glob-to-any-file: "user_manual/**"
15+
16+
"github_actions":
17+
- changed-files:
18+
- any-glob-to-any-file: ".github/workflows/**"

‎.github/pull_request_template.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,10 @@ Please add a screenshot of your changed or added page(s).
99
This helps reviewers to quickly see how the resulting
1010
lists, code blocks, headers and links look.
1111
-->
12+
13+
### ✅ Checklist
14+
15+
- [ ] I have built the documentation locally and reviewed the output
16+
- [ ] Screenshots are included for visual changes
17+
- [ ] I have not moved or renamed pages (or added a redirect if I did)
18+
- [ ] I have run `codespell` or similar and addressed any spelling issues

‎.github/release-notes-instructions.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Release Notes Instructions
2+
3+
When generating release notes for a new release, use the following prompt with GitHub Copilot (or another AI assistant), substituting the changelog and version number as appropriate.
4+
5+
---
6+
7+
## Prompt
8+
9+
Generate release notes for **[version]** of the `nextcloud/documentation` repository based on the following changelog.
10+
11+
For each PR in the changelog, look up the original (non-backport) PR to identify the true author. Organize the release notes into sections by which manual the PR touches: **Admin Manual**, **Developer Manual**, and **User Manual**. If a PR touches multiple manuals, include it in each relevant section with a summary appropriately tuned to that manual's audience. Eliminate any section for which there are no PRs.
12+
13+
For each entry, write a concise human-readable summary (not just the PR title), and attribute it with `by @author in #number`.
14+
15+
At the end, include a **New Contributors** section calling out any authors whose `author_association` on the original PR is `CONTRIBUTOR` (rather than `MEMBER`) — these are first-time or external contributors.
16+
17+
All PRs are backported via `@backportbot` — include a note at the bottom acknowledging this and clarifying that original authors are credited throughout.
18+
19+
**Changelog:**
20+
21+
[paste changelog here]
22+
23+
---
24+
25+
## Notes
26+
27+
- The changelog can be found on the [releases page](https://github.com/nextcloud/documentation/releases) or generated via GitHub's "Generate release notes" button as a starting point.
28+
- The key instructions that drive the correct output are:
29+
1. **Look up original PRs** to get the real author, not `backportbot`
30+
2. **Organize by manual**, not by type of change
31+
3. **Cross-manual PRs appear in each relevant section** with tuned summaries
32+
4. **`CONTRIBUTOR` association = new/external contributor** worth calling out

0 commit comments

Comments
 (0)