Skip to content

Commit

Permalink
DNM: POC for LP user documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
keirthana committed Sep 24, 2024
1 parent ce5408a commit aa10020
Show file tree
Hide file tree
Showing 110 changed files with 487 additions and 26 deletions.
7 changes: 6 additions & 1 deletion custom_conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,12 @@
# Set up redirects (https://documatt.gitlab.io/sphinx-reredirects/usage.html)
# For example: 'explanation/old-name.html': '../how-to/prettify.html',

redirects = {}
redirects = {
'/tutorials': '/developing-launchpad/tutorials',
'/how-to': '/developing-launchpad/how-to',
'/explanation': '/developing-launchpad/explanation',
'/reference': '/developing-launchpad/reference',
}

############################################################
### Link checker exceptions
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
70 changes: 70 additions & 0 deletions developing-launchpad/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
Developing Launchpad
====================

**Launchpad is a collaboration platform for open-source projects.**

**Launchpad provides everything necessary to build and publish software,
including code hosting, issue tracking, translations,
and request tracking for bugs and features.**
The most famous software hosted on Launchpad is Ubuntu.

**Launchpad provides unique features needed in modern software development,
especially in open-source development.**
These include build capacities for many different languages and package formats
across standard architectures, but also including rising stars such as RISC-V
and ARM. Launchpad also offers unparalleled tracking capabilities across issue
trackers to seamlessly communicate with upstream projects.

**With its unique features, Launchpad is the right tool for companies,
professionals, open-source maintainers, and hobbyists alike.**



---------

In this documentation
---------------------

.. grid:: 1 1 2 2

.. grid-item:: :doc:`Tutorials <tutorials/index>`

**Start here** - hands-on introductions to Launchpad for new developers

.. grid-item:: :doc:`How-to guides <how-to/index>`

**How-to guides** - step-by-step guides covering key operations and common tasks

.. grid:: 1 1 2 2
:reverse:

.. grid-item:: :doc:`Reference <reference/index>`

**Technical information** - specifications, APIs, architecture

.. grid-item:: :doc:`Explanation <explanation/index>`

**Discussion and clarification** of key topics

---------

Project and community
---------------------

Launchpad is a member of the Ubuntu family.
It's an open source project that warmly welcomes community projects,
contributions, suggestions, fixes and constructive feedback.

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

.. toctree::
:hidden:
:maxdepth: 2

tutorials/index
how-to/index
reference/index
explanation/index
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
37 changes: 12 additions & 25 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,26 +27,7 @@ professionals, open-source maintainers, and hobbyists alike.**
In this documentation
---------------------

.. grid:: 1 1 2 2

.. grid-item:: :doc:`Tutorials <tutorials/index>`

**Start here** - hands-on introductions to Launchpad for new developers

.. grid-item:: :doc:`How-to guides <how-to/index>`

**How-to guides** - step-by-step guides covering key operations and common tasks

.. grid:: 1 1 2 2
:reverse:

.. grid-item:: :doc:`Reference <reference/index>`

**Technical information** - specifications, APIs, architecture

.. grid-item:: :doc:`Explanation <explanation/index>`

**Discussion and clarification** of key topics
We have documentation for Launchpad users and developers.

---------

Expand All @@ -64,11 +45,17 @@ contributions, suggestions, fixes and constructive feedback.

.. toctree::
:hidden:
:maxdepth: 2

tutorials/index
how-to/index
reference/index
explanation/index
developing-launchpad/index

.. toctree::
:hidden:

using-launchpad/index

.. toctree::
:hidden:

help
contribute-to-our-docs

83 changes: 83 additions & 0 deletions using-launchpad/explanation/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
:hide-toc:

Explanation
===========
.. toctree::
:maxdepth: 1


The following are suggesting titles and topics for classification under explanation:

- `Launchpad <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/WhatIsLaunchpad.rst>`_
- `Account <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/YourAccount.rst>`_
- `Collaborating using Launchpad <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/YourAccountContactingPeople.rst>`_
- `Karma <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/YourAccountKarma.rst>`_
- Launchpad features

- `Answer tracker <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/FeatureHighlightsAnswerTracker.rst>`_ - This could also include relevant bits from the answers topic in the next launchpad answers section.
- `Code hosting using Bazaar <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/FeatureHighlightsBazaarHosting.rst>`_
- `Blueprints <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/FeatureHighlightsBlueprintReleasePlanning.rst>`_
- `Branch imports <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/FeatureHighlightsBranchImports.rst>`_ - this feels very related to the `how-to guide <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/CodeUploadingABranch.rst>`_.
- Bug tracker
(Combine explanation from the following topics into a bug tracker topic and keep steps isolated in how-to guides.)

- `Landing page for bug tracker <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/BugReportingTool.rst>`_ - explain bug tracker and its abilities but not steps to report a bug.

- Also add https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/BugsYourProject.rst - Introduction to bug tracker
- Also add https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/BugTrackingHighlights.rst - Introduction to bug tracker

- `Bug watch <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/FeatureHighlightsBugWatches.rst>`_
- `Linking bug to branch <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/FeatureHighlightsBugBranchLinking.rst>`_
- `Managing bugs through email <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/FeatureHighlightsBugsByEmail.rst>`_ and `Bug email interface <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/BugsEmailInterface.rst>`_ - consider merging
- `Milestones <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/FeatureHighlightsMilestoneUsage.rst>`_
- `Pages <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/FeatureHighlightsPageLayout.rst>`_
- `Personal Package Archives (PPA) <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/FeatureHighlightsPersonalPackageArchives.rst>`_
- `Product series <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/FeatureHighlightsProductSeries.rst>`_
- `Teams <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/FeatureHighlightsTeamManagement.rst>`_ and `Team branches <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/FeatureHighlightsTeamBranches.rst>`_ - can be merged into one topic titled "Team management"
- `OOPs reports <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/Oops.rst>`_
- `Support tracker <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/SupportTrackerTour.rst>`_
- `Staging environment <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/StagingServer.rst>`_
- `Launchpad mailing lists <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/ListHelp.rst>`_ - some steps can be extracted to a how-to guide on using Launchpad mailing lists. This how-to guide should contain subscribing, using and unsubscribing.
- Also merge `Indirect team members <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/HelpTeamsIndirect.rst>`_

- `Packaging <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/Packaging.rst>`_ - Right now this is just a brief overview and some links to related topics. Rewrite this into an explanation about Packaging as a feature
- `Source package recipes <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/PackagingSourceBuilds.rst>`_
- `Source build recipes <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/PackagingSourceBuildsRecipes.rst>`_
- `Projects in Launchpad <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/Projects.rst>`_

(Consolidate the following topics for explaining projects in LP; Move any actions to how-to guides)
- `Registering your project in LP <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/ProjectsRegistering.rst>`_
- `Closing a project <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/ProjectsClosing.rst>`_
- `Publishing files for download <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/ProjectsFileDownloads.rst>`_
- `Terminator <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/ProjectsAnnouncements.rst>`_
- `Understanding project series, milestones and releases <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/ProjectsSeriesMilestonesReleases.rst>`_
- `Providing support for your project <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/ProvidingSupportThroughLaunchpad.rst>`_

- `Translating your project <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/RosettaHighlights.rst>`_
- Also merge https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/Translations.rst and https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/TranslationsYourProject.rst
- `Translation groups <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/TranslationsJoiningATranslationGroup.rst>`_ (also merge https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/TranslationsYourProjectChoosingAGroup.rst)
- `Translation exports <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/TranslationsYourProjectExports.rst>`_

- `Launchpad Teams <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/Teams.rst>`_
- `Creating and maintaining team <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/TeamsCreatingAndRunning.rst>`_
-

- Launchpad answers
(This could possibly go in the project and community section as well but needs to be very concise. If it is more detailed and presented as feature, let's retain it under Diataxis categories)

- `Answers <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/Answers.rst>`_
- `Answer tracker <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/AnswerTrackerDocumentation.rst>`_ - If possible, combine both answers and answer tracker
- `Ask for help <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/AnswersAskingForHelp.rst>`_ - excluding the how to ask for help part
- `Offer help <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/AnswersOfferingHelp.rst>`_ - excluding steps on how to offer

- Launchpad API

- `launchpadlib <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/APIlaunchpadlib.rst>`_ - Some explanation of what's launchpadlib and the tutorial should link here.
- `Lauchpad resources <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/APIHacking.rst>`_ - information about LP resources need to be separated out as explanation

- Working with code

- `Launchpad CI <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/CodeContinuousIntegration.rst>`_ - Just the overview about LPCI
- `Git Hosting <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/CodeGit.rst>`_ - The overview and supported versions can be condensed into an explanation. Ideally supported features will be a reference but we can keep it with the explanation until there is much more reference material to add.
- `Code Imports <https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/CodeImports.rst>`_
- Merge proposal - Although this is common knowledge, there should be a topic explaining what an MP is and linked to the corresponding how-to guide on how to create an MP. Content of this file can be created from scratch or pulled in from the overview of the how-to guide
Loading

0 comments on commit aa10020

Please sign in to comment.