You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/how-to/contribute-docs.md
+11-14Lines changed: 11 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,24 +1,21 @@
1
1
# How to contribute documentation
2
2
3
-
This guide provides information necessary to contribute to the Ubuntu for Developers documentation, especially if you're contributing for the first time.
3
+
This guide provides information necessary to contribute to this documentation. If you're contributing for the first time, you might find the Canonical Open Documentation Academy has helpful resources to [get you started](https://documentationacademy.org/docs/howto/get-started/).
4
4
5
+
## Report an issue
5
6
6
-
## Reporting an issue
7
+
To report a mistake on any page, or highlight some missing documentation, [file an issue](https://github.com/ubuntu/ubuntu-project-docs/issues) in our issues list on GitHub.
8
+
You can do this using the "Give feedback" button on any page, which will open a new issue.
7
9
8
-
To report a mistake in or make request for the documentation, [file an issue](https://github.com/ubuntu/ubuntu-project-docs/issues) about it in our bug tracker on GitHub.
9
-
to it.
10
+
## Edit documentation online
10
11
11
-
12
-
## Modifying documentation online
13
-
14
-
Each documentation page rendered on the web contains an **Contribute to this page** link in the top-right corner. Clicking this button leads you to the GitHub web editor where you can propose changes to the corresponding page.
12
+
Each documentation page has a **Contribute to this page** link in the top-right corner (the pencil icon). Clicking this button opens the GitHub web editor where you can propose changes to that page. The first time you click this button, you will be prompted to create a **fork** of the documentation before you can start editing.
15
13
16
14
Remember to first check the [latest version](https://canonical-ubuntu-project.readthedocs-hosted.com/) of our documentation and make your proposal based on that revision.
17
15
16
+
## Contribute on GitHub
18
17
19
-
## Contributing on GitHub
20
-
21
-
To follow a Git development workflow, `checkout` the [Ubuntu project docs repository](https://github.com/ubuntu/ubuntu-project-docs) and contribute your changes as [pull requests](https://github.com/ubuntu/ubuntu-project-docs/pulls).
18
+
To follow a Git development workflow, `checkout` the [Ubuntu Project docs repository](https://github.com/ubuntu/ubuntu-project-docs) and contribute your change as a [pull request](https://github.com/ubuntu/ubuntu-project-docs/pulls).
22
19
23
20
24
21
## Directory structure
@@ -50,7 +47,7 @@ Follow these steps to build the documentation on your local machine.
50
47
51
48
### Procedure
52
49
53
-
1. Fork the [Ubuntu project docs repository](https://github.com/ubuntu/ubuntu-project-docs). Visit [Fork a repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) for instructions.
50
+
1. Fork the [Ubuntu Project docs repository](https://github.com/ubuntu/ubuntu-project-docs). Visit [Fork a repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) for instructions.
54
51
55
52
2. Clone the repository to your machine:
56
53
```none
@@ -82,7 +79,7 @@ Follow these steps to build the documentation on your local machine.
82
79
83
80
## Documentation format
84
81
85
-
The Ubuntu for Developers documentation is built with Sphinx using the MyST flavor of the Markdown mark-up language. If you're new to Markdown or MyST, read our [MyST style guide](https://canonical-starter-pack.readthedocs-hosted.com/latest/reference/style-guide-myst/).
82
+
The Ubuntu Project documentation is built with Sphinx using the MyST flavor of the Markdown mark-up language. If you're new to Markdown or MyST, read our [MyST style guide](https://canonical-starter-pack.readthedocs-hosted.com/latest/reference/style-guide-myst/).
86
83
87
84
88
85
## Testing the documentation
@@ -107,7 +104,7 @@ If you've never contributed to an open source project before, the [Open Document
107
104
108
105
The Open Documentation Academy (ODA) is an initiative led by the documentation team at Canonical to encourage open source contributions from the community, and to provide help, advice and mentorship within a friendly and welcoming environment.
109
106
110
-
A key aim of the initiative is to lower the barrier to successful open-source software contributions by making documentation into the gateway, and it’s a great way to make your first open source contributions to projects like ours. Contributors gain real experience, structured support and recognition, while we benefit from improvements to our documentation and community feedback.
107
+
A key aim is to lower the barrier of entry to successful open-source software contributions by making documentation into the gateway, and it’s a great way to make your first open source contributions to projects like ours. Contributors gain real experience, structured support and recognition, while we benefit from improvements to our documentation and community feedback.
111
108
112
109
The best way to get started is to take a look at our [project-related documentation tasks](https://github.com/canonical/open-documentation-academy/issues) and read our [Getting started](https://discourse.ubuntu.com/t/getting-started/42769) guide. Tasks typically include testing and fixing tutorials, updating outdated pages, restructuring large documents and anything else you may want to suggest. We'll help you see those tasks through to completion.
0 commit comments