Improve home page #25
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| .. _index: | ||
|
|
||
| Ubuntu Packaging Guide | ||
| ====================== | ||
|
|
||
| .. important:: | ||
|
|
||
|
|
@@ -42,7 +42,8 @@ make Ubuntu better together with us. | |
|
|
||
| ----- | ||
|
|
||
| In this documentation | ||
| --------------------- | ||
|
|
||
|
|
||
| .. grid:: 1 1 2 2 | ||
|
|
@@ -73,28 +74,37 @@ The guide is split up into two sections: | |
|
|
||
| Technical information - specifications, APIs, architecture | ||
|
|
||
| Project and community | ||
| --------------------- | ||
|
|
||
| The Ubuntu Packaging Guide is an open source project that warmly welcomes | ||
| community projects, contributions, suggestions, fixes and constructive feedback. Read our `Code of Conduct`_ to get started. | ||
|
|
||
| If you run into problems, don't panic! The following communication channels are there to help you through: | ||
|
|
||
| Mailing lists: | ||
| ~~~~~~~~~~~~~~ | ||
| In a project where thousands of lines of code are changed, lots of decisions | ||
| are made and hundreds of people interact every day, it is important to | ||
| communicate effectively. | ||
|
|
||
| * https://lists.ubuntu.com/mailman/listinfo/ubuntu-devel-announce | ||
| (announce-only, the most important development announcements go here) | ||
| * https://lists.ubuntu.com/mailman/listinfo/ubuntu-devel | ||
| (general Ubuntu development discussion) | ||
| * https://lists.ubuntu.com/mailman/listinfo/ubuntu-motu | ||
| (MOTU Team discussion, get help with packaging) | ||
|
|
||
| IRC channels: | ||
| ~~~~~~~~~~~~~ | ||
| For real-time discussions, please connect to irc.libera.chat and join one or | ||
| any of these channels: | ||
|
|
||
| * #ubuntu-devel (for general development discussion) | ||
| * #ubuntu-motu (for MOTU team discussion and generally getting help) | ||
|
There was a problem hiding this comment. These channels do still exist and are still used. I'm not sure if there are any other channels that should be included - or any that the Community team would like us to add. Could be worth checking with Aaron? There was a problem hiding this comment. thought: The problem is that it depends on what you want to do in Ubuntu. Recommending those two in general seems fine to me. issue: We have to explain to beginners what "MOTU" (Masters of the Universe, see https://wiki.ubuntu.com/MOTU) is. thought: I thought of adding a glossary (https://sublime-and-sphinx-guide.readthedocs.io/en/latest/glossary.html) for terms like MOTU, FTBFS, NBS, ... that show up frequently in Ubuntu communication. Maybe we should even add a small glossary for slang abbreviations like ACK, IIRC, AFAICT, ... Because they confused the heck out of me when I started. There was a problem hiding this comment. Glossary is a good idea. For now, I have included the link and the expanded form of MOTU. |
||
|
|
||
| We are always looking to improve this guide. If you find any problems or have | ||
| some suggestions, use the **Give feedback** button at the top of any page to open a GitHub issue or directly contribute by submitting a pull request to the `source`_ repository. | ||
|
|
||
| .. toctree:: | ||
| :hidden: | ||
|
|
@@ -107,23 +117,19 @@ community projects, contributions, suggestions, fixes and constructive feedback. | |
| contribute.rst | ||
|
|
||
| Further reading | ||
| --------------- | ||
|
|
||
| You can read this guide offline in different formats, if you install one of | ||
| the `binary packages <BinPkgs_>`_. | ||
|
There was a problem hiding this comment. We will probably want to update the source of this link, since this still points to Launchpad. Although the Launchpad version will still be there - Dave or Dominik can probably confirm which is the best to use. There was a problem hiding this comment. note: @waveform80 is currently working on this, but I think the link will not change. The current binary package is just outdated. |
||
|
|
||
| If you want to learn more about building Debian packages, here are some Debian | ||
| resources you may find useful: | ||
|
|
||
| * `How to package for Debian <HowToPackage_>`_ | ||
| * `Debian Policy Manual <Policy_>`_ | ||
| * `Debian New Maintainers' Guide <NewMaintGuide_>`_ — available in many languages | ||
| * `Packaging tutorial <PkgTutorial_>`_ (also available as a `package <PkgTutorialPkg_>`_) | ||
| * `Guide for Packaging Python Modules <PythonModules_>`_ | ||
|
|
||
| .. Links: | ||
| .. _Code of Conduct: https://ubuntu.com/community/code-of-conduct | ||
|
|
@@ -134,6 +140,5 @@ If you'd like to help work on the guide, `grab the source <Source_>`_ there as w | |
| .. _NewMaintGuide: http://www.debian.org/doc/manuals/maint-guide/ | ||
| .. _PkgTutorial: http://www.debian.org/doc/manuals/packaging-tutorial/ | ||
| .. _PkgTutorialPkg: https://launchpad.net/ubuntu/+source/packaging-tutorial | ||
| .. _PythonModules: https://wiki.debian.org/Python/LibraryStyleGuide | ||
| .. _source: https://github.com/canonical/ubuntu-packaging-guide | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's important to specifically call out the code of conduct/draw attention to it by separating it off: I prefer it as a bullet point (although I'm not sure it would make sense here with only one bullet point!)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With the current reformat, a separate bullet point does not make sense but I did make it the beginning of a paragraph to garner more attention, WDYT?