-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #30 from sn3rd/main
Add a new page inviting contributions to Launchpad documentation
- Loading branch information
Showing
5 changed files
with
87 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
Contribute to our docs | ||
====================== | ||
|
||
We are committed to continuously improving our documentation and making it | ||
more useful for both ourselves and others. | ||
|
||
**We warmly welcome community contributions, suggestions, fixes, and | ||
constructive feedback.** | ||
|
||
To contribute, go ahead and submit an issue or pull request at | ||
https://github.com/canonical/launchpad-manual. | ||
|
||
If you have any questions or doubts, please don't hesitate to | ||
reach out to us by any of these means: | ||
|
||
- Join the `#launchpad IRC channel`_ at `irc.libera.chat`_ and ask your | ||
questions. | ||
- Ask a question: https://answers.launchpad.net/launchpad | ||
- Send an e-mail to [email protected] | ||
|
||
Style and language | ||
++++++++++++++++++ | ||
|
||
Launchpad's documentation is aimed at helping both beginners and experts. As | ||
such, we try to use appropriate writing for the subject, to use inclusive | ||
language, and to assume that the reader has as little prior knowledge as | ||
possible. | ||
|
||
The nativation, structure, style, and content of our documentation follows the | ||
`Diátaxis`_ systematic framework for technical documentation authoring. This | ||
splits pages into tutorials, how-to guides, reference material, and | ||
explanatory text. | ||
|
||
Some general tips that could help to ensure high quality documentation: | ||
|
||
- use a spell checker | ||
- resist being overly formal | ||
- resist being overly verbose | ||
- verify links and examples | ||
|
||
We recommend using the `Ubuntu style guide`_. | ||
|
||
Feel free to suggest changes to any documentation topic with updated or more | ||
insightful information. We aim for consistency, but don't let formality | ||
prevent you from contributing. If something is inconsistent, we'll fix it. | ||
We'd rather have documentation that we can fix than not have documentation at | ||
all. | ||
|
||
.. _#launchpad IRC channel: irc://irc.libera.chat/launchpad | ||
.. _irc.libera.chat: irc.libera.chat | ||
.. _API documentation: http://people.canonical.com/~mwh/canonicalapi/ | ||
.. _Diátaxis: https://diataxis.fr/ | ||
.. _Ubuntu style guide: https://docs.ubuntu.com/styleguide/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters