Skip to content

Commit b85074e

Browse files
RCheesleyRCheesley
authored
Merge branch '5.x' into api-v2-doc
2 parents 31b631d + ba73419 commit b85074e

22 files changed

+607
-358
lines changed

‎.ddev/commands/web/build-docs‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
#!/usr/bin/env bash
2+
3+
## Description: Build User documentation using the Sphinx HTML builder.
4+
## Usage: build-docs
5+
## Example: ddev build-docs
6+
7+
# Ensure we fail on error
8+
set -e
9+
10+
# Initialize terminal colors/styles
11+
bold=$(tput bold)
12+
green=$(tput setaf 2)
13+
reset=$(tput sgr0)
14+
underline=$(tput smul)
15+
16+
echo "${bold}${green}🔧 Building user documentation...${reset}"
17+
18+
# Ensure we're in the right directory
19+
cd /var/www/html/docs
20+
echo
21+
22+
# Run the build
23+
make html
24+
25+
# Success message
26+
echo
27+
echo "${green}✅ Documentation build completed successfully!${reset}"
28+
echo "${green}📁 The HTML pages are in: ${bold}/var/www/html/docs/build/html${reset}"
29+
30+
# Friendly access hint
31+
echo "${green}🌐 View the documentation at: ${bold}${underline}https://${DDEV_HOSTNAME}${reset}"
32+
echo

‎.ddev/web-build/Dockerfile.sphinx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ RUN curl -sSL https://github.com/pypa/pipx/releases/latest/download/pipx.pyz -o
55
RUN chmod +x /usr/local/bin/pipx
66

77
RUN pipx install --global sphinx
8-
RUN pipx install --force --global --include-deps sphinx-rtd-theme
8+
RUN pipx inject --global sphinx sphinxcontrib-phpdomain sphinx-rtd-theme

‎.github/CODEOWNERS‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# For code owners docs, see: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
2+
3+
# Global owners
4+
5+
* @mautic/education-team-leaders

‎.github/ISSUE_TEMPLATE/01_documentation_fix.yml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: 📝 Documentation Fix
2+
description: Point out an error or suggest a change in the documentation.
3+
title: "[DOCS]:"
4+
labels: ["documentation", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping improve the Mautic Developer Documentation! Please fill out the details below so we can fix it.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: Please describe what is inaccurate, missing, or confusing in the documentation.
16+
placeholder: "e.g., The example code on page X is out of date and no longer works."
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: doc-link
22+
attributes:
23+
label: Relevant Documentation URL
24+
description: Please provide a link to the exact documentation page that needs to be updated.
25+
placeholder: "e.g., https://devdocs.mautic.org/page-to-fix"
26+
27+
- type: dropdown
28+
id: willingness-to-pr
29+
attributes:
30+
label: Are you willing to help us fix this by making a pull request?
31+
description: Contributing a pull request is the fastest way to get this fixed.
32+
options:
33+
- "— Select an option —"
34+
- "No"
35+
- "Yes"
36+
- "Yes, but I need help"
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: suggestions
42+
attributes:
43+
label: Suggestions (Optional)
44+
description: How do you suggest the documentation could be fixed or improved?
45+
placeholder: "e.g., I think changing the example code to this would solve the issue..."
46+
47+
- type: textarea
48+
id: screenshots
49+
attributes:
50+
label: Screenshots or Screen Recordings (Optional)
51+
description: To help us understand the issue visually, please attach any relevant images or recordings.
52+
placeholder: "Drag and drop the files here."

‎.github/ISSUE_TEMPLATE/02_feature_request.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: 🌱 Feature Request
2+
description: Request a new feature or enhancement.
3+
title: "[FEAT]:"
4+
labels: ["enhancement", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a new feature for the Mautic Developer Documentation! Please fill out the details below to help us understand and prioritize it.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: Please provide a clear and concise description of the feature you would like to see.
16+
placeholder: "e.g., I'd like to be able to edit the documentation directly on GitHub. This would be useful because..."
17+
validations:
18+
required: true
19+
20+
- type: dropdown
21+
id: willingness-to-pr
22+
attributes:
23+
label: Are you willing to help us add this feature this by making a pull request?
24+
description: Contributing a pull request is the fastest way to get this fixed.
25+
options:
26+
- "— Select an option —"
27+
- "No"
28+
- "Yes"
29+
- "Yes, but I need help"
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: suggestions
35+
attributes:
36+
label: Suggestions (Optional)
37+
description: How do you suggest this feature should be implemented?
38+
placeholder: "e.g., A user could click the edit button on the documentation page to make changes."

‎.github/ISSUE_TEMPLATE/03_bug_report.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: 🐛 Technical Bug Report
2+
description: Did you find a bug with the documentation system or automations? Create a report to help us improve.
3+
title: "[BUG]:"
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a technical bug within the Mautic Developer Documentation! Please fill out the details below to help us understand and resolve it.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: Provide a clear and concise description of the bug. Include steps to reproduce the behavior, the expected result, and the actual result.
16+
placeholder: "e.g., Running make html command didn't build the docs. Steps to reproduce: 1. Go to the /docs directory. 2. Run make html command. 3. Nothing happens."
17+
validations:
18+
required: true
19+
20+
- type: dropdown
21+
id: willingness-to-pr
22+
attributes:
23+
label: Are you willing to help us fix this by making a pull request?
24+
description: Contributing a pull request is the fastest way to get this fixed.
25+
options:
26+
- "— Select an option —"
27+
- "No"
28+
- "Yes"
29+
- "Yes, but I need help"
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: suggestions
35+
attributes:
36+
label: Suggestions (Optional)
37+
description: How do you suggest this bug could be fixed?
38+
placeholder: "e.g., I think changing X to Y would solve the issue."
39+
40+
- type: textarea
41+
id: environment
42+
attributes:
43+
label: Environment
44+
description: |
45+
Please provide details about your environment where the bug occurred.
46+
- OS/Platform
47+
- Browser & Version
48+
placeholder: "e.g., Windows 11, Chrome v125"
49+
50+
- type: textarea
51+
id: screenshots
52+
attributes:
53+
label: Screenshots or Screen Recordings (Optional)
54+
description: To help us understand the issue visually, please attach any relevant images or recordings.
55+
placeholder: "Drag and drop the files here."

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
contact_links:
2+
- name: Mautic Community Support
3+
url: https://forum.mautic.org/
4+
about: Please ask questions around Mautic product here.
5+
- name: Report a bug for the Mautic product
6+
url: https://github.com/mautic/mautic/issues
7+
about: Please create an issue to report a bug in the Mautic product here.

‎.github/holopin.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,13 @@ holobytes:
33
- evolvingStickerId: cm1ti4x4c57560cjq2styaitm
44
icon: avocado
55
alias: hacktoberfest-2024
6+
7+
- evolvingStickerId: cmg9s1kkz0046l204bc2k5k7e
8+
icon: avocado
9+
alias: hacktoberfest-2025
10+
11+
# First time contributor badge
12+
stickers:
13+
- id: cmc38nn5r166207icbleca9jp
14+
name: First Contribution
15+
alias: first-contribution

‎.github/pull_request_template.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## Description
2+
3+
4+
<!-- PLEASE WRITE ABOVE THIS COMMENT. -->
5+
6+
<!--
7+
8+
Clearly describe what changes you have made in this PR, where our maintainers or reviewers should look at, and how to test the changes.
9+
10+
If the request is not complete but you want feedback or have quetions, you can select the "Draft Pull Request" option from the dropdown menu when creating the PR, then ask your questions or write your feedback in the comment.
11+
12+
-->
13+
14+
## Linked issue
15+
16+
17+
<!-- PLEASE WRITE ABOVE THIS COMMENT. -->
18+
19+
<!--
20+
21+
If your PR is related to a current issue, please link to that issue number. Type the keyword "Closes" followed by a hashtag (#) symbol and the issue number that you can find right after the issue title. Don't add anything else, such as period, comma, etc, to this. For example:
22+
23+
❌ Closes: #123.
24+
25+
✅ Closes #123
26+
27+
Doing so will automatically close the issue when one of our maintainers merges your PR.
28+
29+
-->
30+
31+
## Screenshots or screen recordings
32+
33+
<!--
34+
35+
Provide screenshots or screen recordings before and after the changes, if it's a UI changes. You can simply drag and drop your files above this comment.
36+
37+
-->

‎LICENSE.txt‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Copyright 2013 Mautic
2+
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at
6+
7+
http://www.apache.org/licenses/LICENSE-2.0
8+
9+
Unless required by applicable law or agreed to in writing, software
10+
distributed under the License is distributed on an "AS IS" BASIS,
11+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
See the License for the specific language governing permissions and
13+
limitations under the License.

0 commit comments

Comments
 (0)