Skip to content

Commit

Permalink
Wrap lines to 80 characters
Browse files Browse the repository at this point in the history
Update the "Project and community" section to have links to contribute to both code and docs
Make the call to action to log issues on GitHub stronger, and emphasise discussion via other channels
Position the general tips as a helpful way to ensure better quality documentation
Re-arrange some content to flow a bit better
  • Loading branch information
clinton-fung committed Apr 26, 2024
1 parent d31ced8 commit e260357
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 11 deletions.
34 changes: 24 additions & 10 deletions contribute-to-our-docs.rst
Original file line number Diff line number Diff line change
@@ -1,27 +1,37 @@
Contribute to our docs
======================

We are committed to continuously improving our documentation and making it more useful for both ourselves and others.
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.**
**We warmly welcome community contributions, suggestions, fixes, and
constructive feedback.**

If you feel something is unclear, wrong, or broken, please don't hesitate to reach out to us by any of these means:
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]

Or go ahead and submit an issue or pull request at https://github.com/canonical/launchpad-manual.

Feel free to suggest changes to any documentation topic with updated or more insightful information. The navigation 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.

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.
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:
Some general tips that could help to ensure high quality documentation:

- use a spell checker
- resist being overly formal
Expand All @@ -30,7 +40,11 @@ Some general tips:

We recommend using the `Ubuntu style guide`_.

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.
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
Expand Down
3 changes: 2 additions & 1 deletion index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ contributions, suggestions, fixes and constructive feedback.

* `Code of conduct <https://ubuntu.com/community/ethos/code-of-conduct>`_
* :doc:`Get support <help>`
* :doc:`Contribute <how-to/contributing-changes>`
* :doc:`Contribute to our code <how-to/contributing-changes>`
* :doc:`Contribute to our docs <contribute-to-our-docs>`

.. toctree::
:hidden:
Expand Down

0 comments on commit e260357

Please sign in to comment.