From aa100204dd59dc9f90194850a882b30cb53d2742 Mon Sep 17 00:00:00 2001 From: Keirthana T S Date: Mon, 23 Sep 2024 14:44:08 +0530 Subject: [PATCH] DNM: POC for LP user documentation --- custom_conf.py | 7 +- .../diagrams}/architecture.html | 0 .../explanation}/architecture.rst | 0 .../explanation}/branches.rst | 0 .../explanation}/charms.rst | 0 .../explanation}/code.rst | 0 .../explanation}/codeimport.rst | 0 .../explanation}/concepts.rst | 0 .../explanation}/css-sprites.rst | 0 .../explanation}/css.rst | 0 .../explanation}/database-performance.rst | 0 .../explanation}/datetime-usage.rst | 0 .../engineering-overview-translations.rst | 0 .../explanation}/error-explanations.rst | 0 .../explanation}/favicon.rst | 0 .../explanation}/feature-flags.rst | 0 .../explanation}/framework.rst | 0 .../explanation}/hacking.rst | 0 .../explanation}/images.rst | 0 .../explanation}/index.rst | 0 .../explanation}/javascript-buildsystem.rst | 0 .../javascript-integration-testing.rst | 0 .../explanation}/javascript-unittesting.rst | 0 .../explanation}/launchpad-ppa.rst | 0 .../explanation}/live-patching.rst | 0 .../explanation}/mail.rst | 0 .../explanation}/malone.rst | 0 .../explanation}/navigating.rst | 0 .../explanation}/navigation-menus.rst | 0 .../explanation}/performance.rst | 0 .../explanation}/pip.rst | 0 .../explanation}/postgresql.rst | 0 .../explanation}/pre-merge-reviews.rst | 0 .../explanation}/registry.rst | 0 .../explanation}/running-details.rst | 0 .../explanation}/scope.rst | 0 .../explanation}/security-policy.rst | 0 .../explanation}/security.rst | 0 .../explanation}/storm-migration-guide.rst | 0 .../explanation}/strategy.rst | 0 .../explanation}/template-reuse.rst | 0 .../explanation}/testing.rst | 0 .../explanation}/url-traversal.rst | 0 .../explanation}/values.rst | 0 .../explanation}/webapp-process.rst | 0 .../explanation}/working-with-db-devel.rst | 0 .../explanation}/xxx-policy.rst | 0 .../how-to}/apply-schema-changes.rst | 0 .../how-to}/chameleon.rst | 0 ...ng-availability-of-launchpad-frontends.rst | 0 .../how-to}/common-development-tasks.rst | 0 .../how-to}/contributing-changes.rst | 0 .../how-to}/create-bot-account.rst | 0 .../how-to}/create-job-publish-artifact.rst | 0 .../database-schema-changes-process.rst | 0 .../how-to}/database-setup.rst | 0 .../how-to}/debug-buildfarm-builder.rst | 0 .../debug-tests-with-visual-studio-code.rst | 0 .../deploying-configuration-changes.rst | 0 .../how-to}/develop-with-buildd.rst | 0 .../how-to}/exceptions.rst | 0 .../how-to}/fixing-bugs.rst | 0 .../getting-overview-of-build-farm.rst | 0 .../how-to}/getting-started.rst | 0 .../how-to}/getting.rst | 0 .../how-to}/importing-an-ubuntu-package.rst | 0 .../how-to}/index.rst | 0 .../how-to}/land-update-for-loggerhead.rst | 0 .../how-to}/launchpad-development-tips.rst | 0 .../how-to}/manage-users.rst | 0 .../how-to}/operating-launchpad.rst | 0 ...ting-builders-to-newer-ubuntu-versions.rst | 0 .../how-to}/preserve-query-count.rst | 0 .../how-to}/running.rst | 0 .../how-to}/security.rst | 0 .../how-to}/testing-scripts.rst | 0 .../how-to}/transfer-project-ownership.rst | 0 .../how-to}/triage-bugs.rst | 0 .../update-configuration-for-testing.rst | 0 .../how-to}/use-soyuz-locally.rst | 0 .../how-to}/use-updated-dependency.rst | 0 .../how-to}/using-breakpoints.rst | 0 .../images}/IPerson-hello.png | Bin .../images}/codehosting.png | Bin .../images}/cross-project-collab.svg | 0 .../images}/favicon.png | Bin .../images}/logo.png | Bin .../images}/scope.svg | 0 .../images}/value-flow.svg | 0 developing-launchpad/index.rst | 70 +++++++++++++ .../reference}/css.rst | 0 .../reference}/email.rst | 0 .../reference}/index.rst | 0 .../reference}/python.rst | 0 .../automatic-translations-export.rst | 0 .../reference}/services/build-farm.rst | 0 .../reference}/services/fetch-service.rst | 0 .../reference}/services/git-hosting.rst | 0 .../reference}/services/mirror-prober.rst | 0 .../reference}/services/signing.rst | 0 .../reference}/tests.rst | 0 .../creating-a-page-in-launchpad.rst | 0 .../tutorials}/index.rst | 0 index.rst | 37 +++---- using-launchpad/explanation/index.rst | 83 +++++++++++++++ using-launchpad/how-to/index.rst | 94 +++++++++++++++++ using-launchpad/index.rst | 70 +++++++++++++ using-launchpad/reference/badgekit.rst | 35 +++++++ using-launchpad/reference/index.rst | 98 ++++++++++++++++++ using-launchpad/tutorials/index.rst | 19 ++++ 110 files changed, 487 insertions(+), 26 deletions(-) rename {diagrams => developing-launchpad/diagrams}/architecture.html (100%) rename {explanation => developing-launchpad/explanation}/architecture.rst (100%) rename {explanation => developing-launchpad/explanation}/branches.rst (100%) rename {explanation => developing-launchpad/explanation}/charms.rst (100%) rename {explanation => developing-launchpad/explanation}/code.rst (100%) rename {explanation => developing-launchpad/explanation}/codeimport.rst (100%) rename {explanation => developing-launchpad/explanation}/concepts.rst (100%) rename {explanation => developing-launchpad/explanation}/css-sprites.rst (100%) rename {explanation => developing-launchpad/explanation}/css.rst (100%) rename {explanation => developing-launchpad/explanation}/database-performance.rst (100%) rename {explanation => developing-launchpad/explanation}/datetime-usage.rst (100%) rename {explanation => developing-launchpad/explanation}/engineering-overview-translations.rst (100%) rename {explanation => developing-launchpad/explanation}/error-explanations.rst (100%) rename {explanation => developing-launchpad/explanation}/favicon.rst (100%) rename {explanation => developing-launchpad/explanation}/feature-flags.rst (100%) rename {explanation => developing-launchpad/explanation}/framework.rst (100%) rename {explanation => developing-launchpad/explanation}/hacking.rst (100%) rename {explanation => developing-launchpad/explanation}/images.rst (100%) rename {explanation => developing-launchpad/explanation}/index.rst (100%) rename {explanation => developing-launchpad/explanation}/javascript-buildsystem.rst (100%) rename {explanation => developing-launchpad/explanation}/javascript-integration-testing.rst (100%) rename {explanation => developing-launchpad/explanation}/javascript-unittesting.rst (100%) rename {explanation => developing-launchpad/explanation}/launchpad-ppa.rst (100%) rename {explanation => developing-launchpad/explanation}/live-patching.rst (100%) rename {explanation => developing-launchpad/explanation}/mail.rst (100%) rename {explanation => developing-launchpad/explanation}/malone.rst (100%) rename {explanation => developing-launchpad/explanation}/navigating.rst (100%) rename {explanation => developing-launchpad/explanation}/navigation-menus.rst (100%) rename {explanation => developing-launchpad/explanation}/performance.rst (100%) rename {explanation => developing-launchpad/explanation}/pip.rst (100%) rename {explanation => developing-launchpad/explanation}/postgresql.rst (100%) rename {explanation => developing-launchpad/explanation}/pre-merge-reviews.rst (100%) rename {explanation => developing-launchpad/explanation}/registry.rst (100%) rename {explanation => developing-launchpad/explanation}/running-details.rst (100%) rename {explanation => developing-launchpad/explanation}/scope.rst (100%) rename {explanation => developing-launchpad/explanation}/security-policy.rst (100%) rename {explanation => developing-launchpad/explanation}/security.rst (100%) rename {explanation => developing-launchpad/explanation}/storm-migration-guide.rst (100%) rename {explanation => developing-launchpad/explanation}/strategy.rst (100%) rename {explanation => developing-launchpad/explanation}/template-reuse.rst (100%) rename {explanation => developing-launchpad/explanation}/testing.rst (100%) rename {explanation => developing-launchpad/explanation}/url-traversal.rst (100%) rename {explanation => developing-launchpad/explanation}/values.rst (100%) rename {explanation => developing-launchpad/explanation}/webapp-process.rst (100%) rename {explanation => developing-launchpad/explanation}/working-with-db-devel.rst (100%) rename {explanation => developing-launchpad/explanation}/xxx-policy.rst (100%) rename {how-to => developing-launchpad/how-to}/apply-schema-changes.rst (100%) rename {how-to => developing-launchpad/how-to}/chameleon.rst (100%) rename {how-to => developing-launchpad/how-to}/checking-availability-of-launchpad-frontends.rst (100%) rename {how-to => developing-launchpad/how-to}/common-development-tasks.rst (100%) rename {how-to => developing-launchpad/how-to}/contributing-changes.rst (100%) rename {how-to => developing-launchpad/how-to}/create-bot-account.rst (100%) rename {how-to => developing-launchpad/how-to}/create-job-publish-artifact.rst (100%) rename {how-to => developing-launchpad/how-to}/database-schema-changes-process.rst (100%) rename {how-to => developing-launchpad/how-to}/database-setup.rst (100%) rename {how-to => developing-launchpad/how-to}/debug-buildfarm-builder.rst (100%) rename {how-to => developing-launchpad/how-to}/debug-tests-with-visual-studio-code.rst (100%) rename {how-to => developing-launchpad/how-to}/deploying-configuration-changes.rst (100%) rename {how-to => developing-launchpad/how-to}/develop-with-buildd.rst (100%) rename {how-to => developing-launchpad/how-to}/exceptions.rst (100%) rename {how-to => developing-launchpad/how-to}/fixing-bugs.rst (100%) rename {how-to => developing-launchpad/how-to}/getting-overview-of-build-farm.rst (100%) rename {how-to => developing-launchpad/how-to}/getting-started.rst (100%) rename {how-to => developing-launchpad/how-to}/getting.rst (100%) rename {how-to => developing-launchpad/how-to}/importing-an-ubuntu-package.rst (100%) rename {how-to => developing-launchpad/how-to}/index.rst (100%) rename {how-to => developing-launchpad/how-to}/land-update-for-loggerhead.rst (100%) rename {how-to => developing-launchpad/how-to}/launchpad-development-tips.rst (100%) rename {how-to => developing-launchpad/how-to}/manage-users.rst (100%) rename {how-to => developing-launchpad/how-to}/operating-launchpad.rst (100%) rename {how-to => developing-launchpad/how-to}/porting-builders-to-newer-ubuntu-versions.rst (100%) rename {how-to => developing-launchpad/how-to}/preserve-query-count.rst (100%) rename {how-to => developing-launchpad/how-to}/running.rst (100%) rename {how-to => developing-launchpad/how-to}/security.rst (100%) rename {how-to => developing-launchpad/how-to}/testing-scripts.rst (100%) rename {how-to => developing-launchpad/how-to}/transfer-project-ownership.rst (100%) rename {how-to => developing-launchpad/how-to}/triage-bugs.rst (100%) rename {how-to => developing-launchpad/how-to}/update-configuration-for-testing.rst (100%) rename {how-to => developing-launchpad/how-to}/use-soyuz-locally.rst (100%) rename {how-to => developing-launchpad/how-to}/use-updated-dependency.rst (100%) rename {how-to => developing-launchpad/how-to}/using-breakpoints.rst (100%) rename {images => developing-launchpad/images}/IPerson-hello.png (100%) rename {images => developing-launchpad/images}/codehosting.png (100%) rename {images => developing-launchpad/images}/cross-project-collab.svg (100%) rename {images => developing-launchpad/images}/favicon.png (100%) rename {images => developing-launchpad/images}/logo.png (100%) rename {images => developing-launchpad/images}/scope.svg (100%) rename {images => developing-launchpad/images}/value-flow.svg (100%) create mode 100644 developing-launchpad/index.rst rename {reference => developing-launchpad/reference}/css.rst (100%) rename {reference => developing-launchpad/reference}/email.rst (100%) rename {reference => developing-launchpad/reference}/index.rst (100%) rename {reference => developing-launchpad/reference}/python.rst (100%) rename {reference => developing-launchpad/reference}/services/automatic-translations-export.rst (100%) rename {reference => developing-launchpad/reference}/services/build-farm.rst (100%) rename {reference => developing-launchpad/reference}/services/fetch-service.rst (100%) rename {reference => developing-launchpad/reference}/services/git-hosting.rst (100%) rename {reference => developing-launchpad/reference}/services/mirror-prober.rst (100%) rename {reference => developing-launchpad/reference}/services/signing.rst (100%) rename {reference => developing-launchpad/reference}/tests.rst (100%) rename {tutorials => developing-launchpad/tutorials}/creating-a-page-in-launchpad.rst (100%) rename {tutorials => developing-launchpad/tutorials}/index.rst (100%) create mode 100644 using-launchpad/explanation/index.rst create mode 100644 using-launchpad/how-to/index.rst create mode 100644 using-launchpad/index.rst create mode 100644 using-launchpad/reference/badgekit.rst create mode 100644 using-launchpad/reference/index.rst create mode 100644 using-launchpad/tutorials/index.rst diff --git a/custom_conf.py b/custom_conf.py index c36f640..5ea0915 100644 --- a/custom_conf.py +++ b/custom_conf.py @@ -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 diff --git a/diagrams/architecture.html b/developing-launchpad/diagrams/architecture.html similarity index 100% rename from diagrams/architecture.html rename to developing-launchpad/diagrams/architecture.html diff --git a/explanation/architecture.rst b/developing-launchpad/explanation/architecture.rst similarity index 100% rename from explanation/architecture.rst rename to developing-launchpad/explanation/architecture.rst diff --git a/explanation/branches.rst b/developing-launchpad/explanation/branches.rst similarity index 100% rename from explanation/branches.rst rename to developing-launchpad/explanation/branches.rst diff --git a/explanation/charms.rst b/developing-launchpad/explanation/charms.rst similarity index 100% rename from explanation/charms.rst rename to developing-launchpad/explanation/charms.rst diff --git a/explanation/code.rst b/developing-launchpad/explanation/code.rst similarity index 100% rename from explanation/code.rst rename to developing-launchpad/explanation/code.rst diff --git a/explanation/codeimport.rst b/developing-launchpad/explanation/codeimport.rst similarity index 100% rename from explanation/codeimport.rst rename to developing-launchpad/explanation/codeimport.rst diff --git a/explanation/concepts.rst b/developing-launchpad/explanation/concepts.rst similarity index 100% rename from explanation/concepts.rst rename to developing-launchpad/explanation/concepts.rst diff --git a/explanation/css-sprites.rst b/developing-launchpad/explanation/css-sprites.rst similarity index 100% rename from explanation/css-sprites.rst rename to developing-launchpad/explanation/css-sprites.rst diff --git a/explanation/css.rst b/developing-launchpad/explanation/css.rst similarity index 100% rename from explanation/css.rst rename to developing-launchpad/explanation/css.rst diff --git a/explanation/database-performance.rst b/developing-launchpad/explanation/database-performance.rst similarity index 100% rename from explanation/database-performance.rst rename to developing-launchpad/explanation/database-performance.rst diff --git a/explanation/datetime-usage.rst b/developing-launchpad/explanation/datetime-usage.rst similarity index 100% rename from explanation/datetime-usage.rst rename to developing-launchpad/explanation/datetime-usage.rst diff --git a/explanation/engineering-overview-translations.rst b/developing-launchpad/explanation/engineering-overview-translations.rst similarity index 100% rename from explanation/engineering-overview-translations.rst rename to developing-launchpad/explanation/engineering-overview-translations.rst diff --git a/explanation/error-explanations.rst b/developing-launchpad/explanation/error-explanations.rst similarity index 100% rename from explanation/error-explanations.rst rename to developing-launchpad/explanation/error-explanations.rst diff --git a/explanation/favicon.rst b/developing-launchpad/explanation/favicon.rst similarity index 100% rename from explanation/favicon.rst rename to developing-launchpad/explanation/favicon.rst diff --git a/explanation/feature-flags.rst b/developing-launchpad/explanation/feature-flags.rst similarity index 100% rename from explanation/feature-flags.rst rename to developing-launchpad/explanation/feature-flags.rst diff --git a/explanation/framework.rst b/developing-launchpad/explanation/framework.rst similarity index 100% rename from explanation/framework.rst rename to developing-launchpad/explanation/framework.rst diff --git a/explanation/hacking.rst b/developing-launchpad/explanation/hacking.rst similarity index 100% rename from explanation/hacking.rst rename to developing-launchpad/explanation/hacking.rst diff --git a/explanation/images.rst b/developing-launchpad/explanation/images.rst similarity index 100% rename from explanation/images.rst rename to developing-launchpad/explanation/images.rst diff --git a/explanation/index.rst b/developing-launchpad/explanation/index.rst similarity index 100% rename from explanation/index.rst rename to developing-launchpad/explanation/index.rst diff --git a/explanation/javascript-buildsystem.rst b/developing-launchpad/explanation/javascript-buildsystem.rst similarity index 100% rename from explanation/javascript-buildsystem.rst rename to developing-launchpad/explanation/javascript-buildsystem.rst diff --git a/explanation/javascript-integration-testing.rst b/developing-launchpad/explanation/javascript-integration-testing.rst similarity index 100% rename from explanation/javascript-integration-testing.rst rename to developing-launchpad/explanation/javascript-integration-testing.rst diff --git a/explanation/javascript-unittesting.rst b/developing-launchpad/explanation/javascript-unittesting.rst similarity index 100% rename from explanation/javascript-unittesting.rst rename to developing-launchpad/explanation/javascript-unittesting.rst diff --git a/explanation/launchpad-ppa.rst b/developing-launchpad/explanation/launchpad-ppa.rst similarity index 100% rename from explanation/launchpad-ppa.rst rename to developing-launchpad/explanation/launchpad-ppa.rst diff --git a/explanation/live-patching.rst b/developing-launchpad/explanation/live-patching.rst similarity index 100% rename from explanation/live-patching.rst rename to developing-launchpad/explanation/live-patching.rst diff --git a/explanation/mail.rst b/developing-launchpad/explanation/mail.rst similarity index 100% rename from explanation/mail.rst rename to developing-launchpad/explanation/mail.rst diff --git a/explanation/malone.rst b/developing-launchpad/explanation/malone.rst similarity index 100% rename from explanation/malone.rst rename to developing-launchpad/explanation/malone.rst diff --git a/explanation/navigating.rst b/developing-launchpad/explanation/navigating.rst similarity index 100% rename from explanation/navigating.rst rename to developing-launchpad/explanation/navigating.rst diff --git a/explanation/navigation-menus.rst b/developing-launchpad/explanation/navigation-menus.rst similarity index 100% rename from explanation/navigation-menus.rst rename to developing-launchpad/explanation/navigation-menus.rst diff --git a/explanation/performance.rst b/developing-launchpad/explanation/performance.rst similarity index 100% rename from explanation/performance.rst rename to developing-launchpad/explanation/performance.rst diff --git a/explanation/pip.rst b/developing-launchpad/explanation/pip.rst similarity index 100% rename from explanation/pip.rst rename to developing-launchpad/explanation/pip.rst diff --git a/explanation/postgresql.rst b/developing-launchpad/explanation/postgresql.rst similarity index 100% rename from explanation/postgresql.rst rename to developing-launchpad/explanation/postgresql.rst diff --git a/explanation/pre-merge-reviews.rst b/developing-launchpad/explanation/pre-merge-reviews.rst similarity index 100% rename from explanation/pre-merge-reviews.rst rename to developing-launchpad/explanation/pre-merge-reviews.rst diff --git a/explanation/registry.rst b/developing-launchpad/explanation/registry.rst similarity index 100% rename from explanation/registry.rst rename to developing-launchpad/explanation/registry.rst diff --git a/explanation/running-details.rst b/developing-launchpad/explanation/running-details.rst similarity index 100% rename from explanation/running-details.rst rename to developing-launchpad/explanation/running-details.rst diff --git a/explanation/scope.rst b/developing-launchpad/explanation/scope.rst similarity index 100% rename from explanation/scope.rst rename to developing-launchpad/explanation/scope.rst diff --git a/explanation/security-policy.rst b/developing-launchpad/explanation/security-policy.rst similarity index 100% rename from explanation/security-policy.rst rename to developing-launchpad/explanation/security-policy.rst diff --git a/explanation/security.rst b/developing-launchpad/explanation/security.rst similarity index 100% rename from explanation/security.rst rename to developing-launchpad/explanation/security.rst diff --git a/explanation/storm-migration-guide.rst b/developing-launchpad/explanation/storm-migration-guide.rst similarity index 100% rename from explanation/storm-migration-guide.rst rename to developing-launchpad/explanation/storm-migration-guide.rst diff --git a/explanation/strategy.rst b/developing-launchpad/explanation/strategy.rst similarity index 100% rename from explanation/strategy.rst rename to developing-launchpad/explanation/strategy.rst diff --git a/explanation/template-reuse.rst b/developing-launchpad/explanation/template-reuse.rst similarity index 100% rename from explanation/template-reuse.rst rename to developing-launchpad/explanation/template-reuse.rst diff --git a/explanation/testing.rst b/developing-launchpad/explanation/testing.rst similarity index 100% rename from explanation/testing.rst rename to developing-launchpad/explanation/testing.rst diff --git a/explanation/url-traversal.rst b/developing-launchpad/explanation/url-traversal.rst similarity index 100% rename from explanation/url-traversal.rst rename to developing-launchpad/explanation/url-traversal.rst diff --git a/explanation/values.rst b/developing-launchpad/explanation/values.rst similarity index 100% rename from explanation/values.rst rename to developing-launchpad/explanation/values.rst diff --git a/explanation/webapp-process.rst b/developing-launchpad/explanation/webapp-process.rst similarity index 100% rename from explanation/webapp-process.rst rename to developing-launchpad/explanation/webapp-process.rst diff --git a/explanation/working-with-db-devel.rst b/developing-launchpad/explanation/working-with-db-devel.rst similarity index 100% rename from explanation/working-with-db-devel.rst rename to developing-launchpad/explanation/working-with-db-devel.rst diff --git a/explanation/xxx-policy.rst b/developing-launchpad/explanation/xxx-policy.rst similarity index 100% rename from explanation/xxx-policy.rst rename to developing-launchpad/explanation/xxx-policy.rst diff --git a/how-to/apply-schema-changes.rst b/developing-launchpad/how-to/apply-schema-changes.rst similarity index 100% rename from how-to/apply-schema-changes.rst rename to developing-launchpad/how-to/apply-schema-changes.rst diff --git a/how-to/chameleon.rst b/developing-launchpad/how-to/chameleon.rst similarity index 100% rename from how-to/chameleon.rst rename to developing-launchpad/how-to/chameleon.rst diff --git a/how-to/checking-availability-of-launchpad-frontends.rst b/developing-launchpad/how-to/checking-availability-of-launchpad-frontends.rst similarity index 100% rename from how-to/checking-availability-of-launchpad-frontends.rst rename to developing-launchpad/how-to/checking-availability-of-launchpad-frontends.rst diff --git a/how-to/common-development-tasks.rst b/developing-launchpad/how-to/common-development-tasks.rst similarity index 100% rename from how-to/common-development-tasks.rst rename to developing-launchpad/how-to/common-development-tasks.rst diff --git a/how-to/contributing-changes.rst b/developing-launchpad/how-to/contributing-changes.rst similarity index 100% rename from how-to/contributing-changes.rst rename to developing-launchpad/how-to/contributing-changes.rst diff --git a/how-to/create-bot-account.rst b/developing-launchpad/how-to/create-bot-account.rst similarity index 100% rename from how-to/create-bot-account.rst rename to developing-launchpad/how-to/create-bot-account.rst diff --git a/how-to/create-job-publish-artifact.rst b/developing-launchpad/how-to/create-job-publish-artifact.rst similarity index 100% rename from how-to/create-job-publish-artifact.rst rename to developing-launchpad/how-to/create-job-publish-artifact.rst diff --git a/how-to/database-schema-changes-process.rst b/developing-launchpad/how-to/database-schema-changes-process.rst similarity index 100% rename from how-to/database-schema-changes-process.rst rename to developing-launchpad/how-to/database-schema-changes-process.rst diff --git a/how-to/database-setup.rst b/developing-launchpad/how-to/database-setup.rst similarity index 100% rename from how-to/database-setup.rst rename to developing-launchpad/how-to/database-setup.rst diff --git a/how-to/debug-buildfarm-builder.rst b/developing-launchpad/how-to/debug-buildfarm-builder.rst similarity index 100% rename from how-to/debug-buildfarm-builder.rst rename to developing-launchpad/how-to/debug-buildfarm-builder.rst diff --git a/how-to/debug-tests-with-visual-studio-code.rst b/developing-launchpad/how-to/debug-tests-with-visual-studio-code.rst similarity index 100% rename from how-to/debug-tests-with-visual-studio-code.rst rename to developing-launchpad/how-to/debug-tests-with-visual-studio-code.rst diff --git a/how-to/deploying-configuration-changes.rst b/developing-launchpad/how-to/deploying-configuration-changes.rst similarity index 100% rename from how-to/deploying-configuration-changes.rst rename to developing-launchpad/how-to/deploying-configuration-changes.rst diff --git a/how-to/develop-with-buildd.rst b/developing-launchpad/how-to/develop-with-buildd.rst similarity index 100% rename from how-to/develop-with-buildd.rst rename to developing-launchpad/how-to/develop-with-buildd.rst diff --git a/how-to/exceptions.rst b/developing-launchpad/how-to/exceptions.rst similarity index 100% rename from how-to/exceptions.rst rename to developing-launchpad/how-to/exceptions.rst diff --git a/how-to/fixing-bugs.rst b/developing-launchpad/how-to/fixing-bugs.rst similarity index 100% rename from how-to/fixing-bugs.rst rename to developing-launchpad/how-to/fixing-bugs.rst diff --git a/how-to/getting-overview-of-build-farm.rst b/developing-launchpad/how-to/getting-overview-of-build-farm.rst similarity index 100% rename from how-to/getting-overview-of-build-farm.rst rename to developing-launchpad/how-to/getting-overview-of-build-farm.rst diff --git a/how-to/getting-started.rst b/developing-launchpad/how-to/getting-started.rst similarity index 100% rename from how-to/getting-started.rst rename to developing-launchpad/how-to/getting-started.rst diff --git a/how-to/getting.rst b/developing-launchpad/how-to/getting.rst similarity index 100% rename from how-to/getting.rst rename to developing-launchpad/how-to/getting.rst diff --git a/how-to/importing-an-ubuntu-package.rst b/developing-launchpad/how-to/importing-an-ubuntu-package.rst similarity index 100% rename from how-to/importing-an-ubuntu-package.rst rename to developing-launchpad/how-to/importing-an-ubuntu-package.rst diff --git a/how-to/index.rst b/developing-launchpad/how-to/index.rst similarity index 100% rename from how-to/index.rst rename to developing-launchpad/how-to/index.rst diff --git a/how-to/land-update-for-loggerhead.rst b/developing-launchpad/how-to/land-update-for-loggerhead.rst similarity index 100% rename from how-to/land-update-for-loggerhead.rst rename to developing-launchpad/how-to/land-update-for-loggerhead.rst diff --git a/how-to/launchpad-development-tips.rst b/developing-launchpad/how-to/launchpad-development-tips.rst similarity index 100% rename from how-to/launchpad-development-tips.rst rename to developing-launchpad/how-to/launchpad-development-tips.rst diff --git a/how-to/manage-users.rst b/developing-launchpad/how-to/manage-users.rst similarity index 100% rename from how-to/manage-users.rst rename to developing-launchpad/how-to/manage-users.rst diff --git a/how-to/operating-launchpad.rst b/developing-launchpad/how-to/operating-launchpad.rst similarity index 100% rename from how-to/operating-launchpad.rst rename to developing-launchpad/how-to/operating-launchpad.rst diff --git a/how-to/porting-builders-to-newer-ubuntu-versions.rst b/developing-launchpad/how-to/porting-builders-to-newer-ubuntu-versions.rst similarity index 100% rename from how-to/porting-builders-to-newer-ubuntu-versions.rst rename to developing-launchpad/how-to/porting-builders-to-newer-ubuntu-versions.rst diff --git a/how-to/preserve-query-count.rst b/developing-launchpad/how-to/preserve-query-count.rst similarity index 100% rename from how-to/preserve-query-count.rst rename to developing-launchpad/how-to/preserve-query-count.rst diff --git a/how-to/running.rst b/developing-launchpad/how-to/running.rst similarity index 100% rename from how-to/running.rst rename to developing-launchpad/how-to/running.rst diff --git a/how-to/security.rst b/developing-launchpad/how-to/security.rst similarity index 100% rename from how-to/security.rst rename to developing-launchpad/how-to/security.rst diff --git a/how-to/testing-scripts.rst b/developing-launchpad/how-to/testing-scripts.rst similarity index 100% rename from how-to/testing-scripts.rst rename to developing-launchpad/how-to/testing-scripts.rst diff --git a/how-to/transfer-project-ownership.rst b/developing-launchpad/how-to/transfer-project-ownership.rst similarity index 100% rename from how-to/transfer-project-ownership.rst rename to developing-launchpad/how-to/transfer-project-ownership.rst diff --git a/how-to/triage-bugs.rst b/developing-launchpad/how-to/triage-bugs.rst similarity index 100% rename from how-to/triage-bugs.rst rename to developing-launchpad/how-to/triage-bugs.rst diff --git a/how-to/update-configuration-for-testing.rst b/developing-launchpad/how-to/update-configuration-for-testing.rst similarity index 100% rename from how-to/update-configuration-for-testing.rst rename to developing-launchpad/how-to/update-configuration-for-testing.rst diff --git a/how-to/use-soyuz-locally.rst b/developing-launchpad/how-to/use-soyuz-locally.rst similarity index 100% rename from how-to/use-soyuz-locally.rst rename to developing-launchpad/how-to/use-soyuz-locally.rst diff --git a/how-to/use-updated-dependency.rst b/developing-launchpad/how-to/use-updated-dependency.rst similarity index 100% rename from how-to/use-updated-dependency.rst rename to developing-launchpad/how-to/use-updated-dependency.rst diff --git a/how-to/using-breakpoints.rst b/developing-launchpad/how-to/using-breakpoints.rst similarity index 100% rename from how-to/using-breakpoints.rst rename to developing-launchpad/how-to/using-breakpoints.rst diff --git a/images/IPerson-hello.png b/developing-launchpad/images/IPerson-hello.png similarity index 100% rename from images/IPerson-hello.png rename to developing-launchpad/images/IPerson-hello.png diff --git a/images/codehosting.png b/developing-launchpad/images/codehosting.png similarity index 100% rename from images/codehosting.png rename to developing-launchpad/images/codehosting.png diff --git a/images/cross-project-collab.svg b/developing-launchpad/images/cross-project-collab.svg similarity index 100% rename from images/cross-project-collab.svg rename to developing-launchpad/images/cross-project-collab.svg diff --git a/images/favicon.png b/developing-launchpad/images/favicon.png similarity index 100% rename from images/favicon.png rename to developing-launchpad/images/favicon.png diff --git a/images/logo.png b/developing-launchpad/images/logo.png similarity index 100% rename from images/logo.png rename to developing-launchpad/images/logo.png diff --git a/images/scope.svg b/developing-launchpad/images/scope.svg similarity index 100% rename from images/scope.svg rename to developing-launchpad/images/scope.svg diff --git a/images/value-flow.svg b/developing-launchpad/images/value-flow.svg similarity index 100% rename from images/value-flow.svg rename to developing-launchpad/images/value-flow.svg diff --git a/developing-launchpad/index.rst b/developing-launchpad/index.rst new file mode 100644 index 0000000..5187007 --- /dev/null +++ b/developing-launchpad/index.rst @@ -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 ` + + **Start here** - hands-on introductions to Launchpad for new developers + + .. grid-item:: :doc:`How-to guides ` + + **How-to guides** - step-by-step guides covering key operations and common tasks + +.. grid:: 1 1 2 2 + :reverse: + + .. grid-item:: :doc:`Reference ` + + **Technical information** - specifications, APIs, architecture + + .. grid-item:: :doc:`Explanation ` + + **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 `_ +* :doc:`Get support ` +* :doc:`Contribute to our code ` +* :doc:`Contribute to our docs ` + +.. toctree:: + :hidden: + :maxdepth: 2 + + tutorials/index + how-to/index + reference/index + explanation/index diff --git a/reference/css.rst b/developing-launchpad/reference/css.rst similarity index 100% rename from reference/css.rst rename to developing-launchpad/reference/css.rst diff --git a/reference/email.rst b/developing-launchpad/reference/email.rst similarity index 100% rename from reference/email.rst rename to developing-launchpad/reference/email.rst diff --git a/reference/index.rst b/developing-launchpad/reference/index.rst similarity index 100% rename from reference/index.rst rename to developing-launchpad/reference/index.rst diff --git a/reference/python.rst b/developing-launchpad/reference/python.rst similarity index 100% rename from reference/python.rst rename to developing-launchpad/reference/python.rst diff --git a/reference/services/automatic-translations-export.rst b/developing-launchpad/reference/services/automatic-translations-export.rst similarity index 100% rename from reference/services/automatic-translations-export.rst rename to developing-launchpad/reference/services/automatic-translations-export.rst diff --git a/reference/services/build-farm.rst b/developing-launchpad/reference/services/build-farm.rst similarity index 100% rename from reference/services/build-farm.rst rename to developing-launchpad/reference/services/build-farm.rst diff --git a/reference/services/fetch-service.rst b/developing-launchpad/reference/services/fetch-service.rst similarity index 100% rename from reference/services/fetch-service.rst rename to developing-launchpad/reference/services/fetch-service.rst diff --git a/reference/services/git-hosting.rst b/developing-launchpad/reference/services/git-hosting.rst similarity index 100% rename from reference/services/git-hosting.rst rename to developing-launchpad/reference/services/git-hosting.rst diff --git a/reference/services/mirror-prober.rst b/developing-launchpad/reference/services/mirror-prober.rst similarity index 100% rename from reference/services/mirror-prober.rst rename to developing-launchpad/reference/services/mirror-prober.rst diff --git a/reference/services/signing.rst b/developing-launchpad/reference/services/signing.rst similarity index 100% rename from reference/services/signing.rst rename to developing-launchpad/reference/services/signing.rst diff --git a/reference/tests.rst b/developing-launchpad/reference/tests.rst similarity index 100% rename from reference/tests.rst rename to developing-launchpad/reference/tests.rst diff --git a/tutorials/creating-a-page-in-launchpad.rst b/developing-launchpad/tutorials/creating-a-page-in-launchpad.rst similarity index 100% rename from tutorials/creating-a-page-in-launchpad.rst rename to developing-launchpad/tutorials/creating-a-page-in-launchpad.rst diff --git a/tutorials/index.rst b/developing-launchpad/tutorials/index.rst similarity index 100% rename from tutorials/index.rst rename to developing-launchpad/tutorials/index.rst diff --git a/index.rst b/index.rst index 840a47f..fff91f4 100644 --- a/index.rst +++ b/index.rst @@ -27,26 +27,7 @@ professionals, open-source maintainers, and hobbyists alike.** In this documentation --------------------- -.. grid:: 1 1 2 2 - - .. grid-item:: :doc:`Tutorials ` - - **Start here** - hands-on introductions to Launchpad for new developers - - .. grid-item:: :doc:`How-to guides ` - - **How-to guides** - step-by-step guides covering key operations and common tasks - -.. grid:: 1 1 2 2 - :reverse: - - .. grid-item:: :doc:`Reference ` - - **Technical information** - specifications, APIs, architecture - - .. grid-item:: :doc:`Explanation ` - - **Discussion and clarification** of key topics +We have documentation for Launchpad users and developers. --------- @@ -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 + \ No newline at end of file diff --git a/using-launchpad/explanation/index.rst b/using-launchpad/explanation/index.rst new file mode 100644 index 0000000..cec75e3 --- /dev/null +++ b/using-launchpad/explanation/index.rst @@ -0,0 +1,83 @@ +:hide-toc: + +Explanation +=========== +.. toctree:: + :maxdepth: 1 + + +The following are suggesting titles and topics for classification under explanation: + +- `Launchpad `_ + - `Account `_ + - `Collaborating using Launchpad `_ + - `Karma `_ +- Launchpad features + + - `Answer tracker `_ - This could also include relevant bits from the answers topic in the next launchpad answers section. + - `Code hosting using Bazaar `_ + - `Blueprints `_ + - `Branch imports `_ - this feels very related to the `how-to guide `_. + - 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 `_ - 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 `_ + - `Linking bug to branch `_ + - `Managing bugs through email `_ and `Bug email interface `_ - consider merging + - `Milestones `_ + - `Pages `_ + - `Personal Package Archives (PPA) `_ + - `Product series `_ + - `Teams `_ and `Team branches `_ - can be merged into one topic titled "Team management" + - `OOPs reports `_ + - `Support tracker `_ + - `Staging environment `_ + - `Launchpad mailing lists `_ - 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 `_ + + - `Packaging `_ - 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 `_ + - `Source build recipes `_ + - `Projects in Launchpad `_ + + (Consolidate the following topics for explaining projects in LP; Move any actions to how-to guides) + - `Registering your project in LP `_ + - `Closing a project `_ + - `Publishing files for download `_ + - `Terminator `_ + - `Understanding project series, milestones and releases `_ + - `Providing support for your project `_ + + - `Translating your project `_ + - 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 `_ (also merge https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/TranslationsYourProjectChoosingAGroup.rst) + - `Translation exports `_ + + - `Launchpad Teams `_ + - `Creating and maintaining team `_ + - + + - 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 `_ + - `Answer tracker `_ - If possible, combine both answers and answer tracker + - `Ask for help `_ - excluding the how to ask for help part + - `Offer help `_ - excluding steps on how to offer + +- Launchpad API + + - `launchpadlib `_ - Some explanation of what's launchpadlib and the tutorial should link here. + - `Lauchpad resources `_ - information about LP resources need to be separated out as explanation + +- Working with code + + - `Launchpad CI `_ - Just the overview about LPCI + - `Git Hosting `_ - 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 `_ + - 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 diff --git a/using-launchpad/how-to/index.rst b/using-launchpad/how-to/index.rst new file mode 100644 index 0000000..b3dc217 --- /dev/null +++ b/using-launchpad/how-to/index.rst @@ -0,0 +1,94 @@ +:hide-toc: + +How-to guides +============= +.. toctree:: + :maxdepth: 1 + + +The following are suggesting titles and topics for classification under how-to guides: + +- Getting started + - `Create an SSH key pair `_ + - `Import PGP key `_ + - `Create new account `_ + - `Merge two LP accounts `_ + +- Launchpad answers + + - `Ask for help using Launchpad answers `_ - Only the steps; everything else should be explanation + - `Offer help using Launchpad answers `_ - Only the steps; everything else should be explanation + - `FAQs `_ - Split this topic into 3 how-to guides as per the sub sections + +- Launchpad API + + - `Use Launchpad API `_ - this should probably be the landing page + - `Make HTTP requests to LP `_ + - `Create and use LP credentials `_ + - `Integrate third-party applications `_ + - `Create and test webhooks using LP API `_ + +- Packaging + + - `Installing from a privte PPA `_ - Topic header says this feature is not yet available on LP.Evaluate! + - `Installing software from a PPA `_ + - `Uploading a package to a PPA `_ + - `Set up daily builds using bzr-builder `_ + - `Troubleshooting packaging errors `_ + +- Work with bugs + + - `Create bug reporting guidelines for your project `_ + - `Report a bug `_ - From this topic, add the steps of how to report a bug here + - `Link a branch to a bug report `_ - Seems related to `Bug branch linking feature description `_. Consider merging. + - `Register a custom bug tracker using Bugzilla `_ + - `Register a bug trackers using Trac `_ - if required, some explanation about the Trac LP plugin can be added, there is not much in the current topic. + - Use Bug email interface + (Merge the following two topics; there are too many scenarios here; Can convert the most important ones into a tutorial such as "Getting started with the email interface" and use how-to guides for the rest. Or alternatively break all of the scenarios into smaller how-to guides.) + + - https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/BugsEmailInterface.rst + - https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/FeatureHighlightsBugsByEmail.rst + - `Import your project's bug history `_ + - `Subscribe/Unsubscribe to bugs `_ - only the steps to subscribe and unsubscribe and link to explanation for more details. + - `Report bugs using the Malone XMLRPC Interface `_ + - `Register and use Mantis bug tracker `_ + +- Using Launchpad with Bazaar + + - `Use Launchpad with Bazaar `_ + - `Create branches `_ + +- `Working with code hosted on Launchpad `_ + + - `Link branches to bug reports `_ + - `Use Launchpad CI `_ + - `Find and download code from Launchpad `_ + - `Host a Git repository on Launchpad `_ - This has other explanation material, isolate the steps for the how-to guide + - `Import code into Launchpad `_ - A lot of content in this topic is explanation, strictly isolate steps for the how-to guide + - `Create and maintain a personal branch on Launchpad `_ + - `Host your code on Launchpad `_ - This seems like the most common use-case, consider turning this into a tutorial + - `Create a merge proposal `_ - There should also be an explanation of what a merge proposal is. + - `Upload your Bazaar branch to Launchpad `_ + +Translations + - `Import translation templates from Bazaar branches `_ + - `Import your project's translation templates `_ - Consider how to related the previous topic and this one + - `Import your project's translations `_ + - `Export a partial PO file `_ - this needs some rework to be a how-to guide + - `Import translation files `_ + - `Exporting translations `_ + +- `Launchpad mailing lists `_ + +- `Projects `_ + +(The project related topics don't contain a lot of steps and have mostly some steps amdist a lot of explanation and reference. Create some simple, direct how-to guides for operations related to projects) + - `Register your project `_ + - Publish your project + - Provide support for your project + - `Import your project from a VCS `_ + +- `Deactivating your LP account `_ + +- Troubleshooting (Collect all troubleshooting information from different topics to this section) + - `Email already in use `_ diff --git a/using-launchpad/index.rst b/using-launchpad/index.rst new file mode 100644 index 0000000..cc2a6f2 --- /dev/null +++ b/using-launchpad/index.rst @@ -0,0 +1,70 @@ +Using 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 ` + + **Start here** - hands-on introductions to Launchpad for new developers + + .. grid-item:: :doc:`How-to guides ` + + **How-to guides** - step-by-step guides covering key operations and common tasks + +.. grid:: 1 1 2 2 + :reverse: + + .. grid-item:: :doc:`Reference ` + + **Technical information** - specifications, APIs, architecture + + .. grid-item:: :doc:`Explanation ` + + **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 `_ +* :doc:`Get support ` +* :doc:`Contribute to our code ` +* :doc:`Contribute to our docs ` + +.. toctree:: + :hidden: + :maxdepth: 2 + + tutorials/index + how-to/index + reference/index + explanation/index diff --git a/using-launchpad/reference/badgekit.rst b/using-launchpad/reference/badgekit.rst new file mode 100644 index 0000000..b821ece --- /dev/null +++ b/using-launchpad/reference/badgekit.rst @@ -0,0 +1,35 @@ +Launchpad Badge Kit +=================== + +If you or your project uses `Launchpad `__, +display one of these badges to let people know! + +**Trademark and usage policy:** *Launchpad*\ ™ is a trademark of +Canonical Ltd. You are encouraged to use these images to refer to your +use of the Launchpad.net services. Canonical may revoke your permission +to use these images if you make modifications to the images or use them +incorrectly (e.g., on a project that does not use Launchpad.net). + +.. image:: http://media.launchpad.net/lp-badge-kit/launchpad-badge-w120px.png +.. image:: http://media.launchpad.net/lp-badge-kit/launchpad-badge-w160px.png +.. image:: http://media.launchpad.net/lp-badge-kit/launchpad-badge-w200px.png +.. image:: http://media.launchpad.net/lp-badge-kit/launchpad-badge-w250px.png + +How to Display a Badge +--------------------- + +Insert HTML like the following into the page where you want to display +the badge, replacing **FILL_ME_IN** with either a project name or a +Launchpad username (if a username, remember to include the **~**, for +example **~joey** as used +`here `__). The default width of +160px is good for most contexts, but you can choose another pixel width +from the list above or make a custom image from the `scalable SVG +file `__ if +necessary. + +:: + + Launchpad logo diff --git a/using-launchpad/reference/index.rst b/using-launchpad/reference/index.rst new file mode 100644 index 0000000..c298812 --- /dev/null +++ b/using-launchpad/reference/index.rst @@ -0,0 +1,98 @@ +:hide-toc: + +Reference +========= +.. toctree:: + :maxdepth: 1 + + +The following are suggesting titles and topics for classification under reference: + +- Launchpad API + + - `Using launchpadlib `_ - This can also be coverted to separate how-to guides or tutorials depending on how useful and important those examples are to the users + - `Using applications based on launchpadlib `_ + - `Programs that use LP API `_ + - `Roles `_ - Assuming there are other roles and not just bug supervisors, having a common reference makes more sense. + +- Bugs +(The different aspects of a bugs such as bug attachments, bug validity could be collated into a single topic if they can be more concise) + + - `Bug validity `_ + - `Bug attachments `_ + - `Bug prioritization `_ + - `Bug expiry `_ + - `Tracking bugs in upstream bug trackers `_ - there is a duplicate of this file `BugsInterBugTrackingDraft.rst`, ignoring it + - `Multi-project bugs `_ + - Also add https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/FeatureHighlightsMultiProjectBugs.rst + - `Bug subscriptions `_ - everything except the steps to subscribe and unsubscribe + +- Bug tracker API + + - `Bug statuses in LP `_ + - Also merge https://github.com/canonical/help.launchpad.net-migration/blob/main/keep/ProjectOverviewEditBugExpiry.rst + - `External bug statuses in LP `_ + - `LP bug tracker plugin API `_ + - `Interoperability with external bug trackers `_ + +- `Software translations `_ +- `Support in your native language `_ +- `Privacy and confidentiality `_ +- `Roles in code review `_ +- `Commenting syntax `_ +- `Commercial hosting `_ +- `Glossary `_ - reassess the need; if it limited, merge with the corresponding explanation and references +- `Rationale headers in Launchpad email `_ +- `Live file system `_ - too little; should be expanded or merged with 'building live filesystems' in developing launchpad docs +- `Loggerhead `_ - too little and lacks context as it is currently +- `Teams `_ +- `Team mailing lists `_ - there are lot of small how-to guides embedded in this topic currently. Considering isolating important procedures as a separate how-to guides. + +- Translations + - `Guide `_ + - `Guidelines `_ + - `Planning to translate `_ + - `Guides used `_ + - `Translation policies `_ + - `Permission policies `_ + - `Translation import policy `_ - consider merging this with the previous topic + - `Translators and localization teams `_ + - `Translation licensing `_ - this is currently an FAQ but should be converted into a reference topic. + - `Plural forms for languages `_ + - `PO templates `_ + - `Reusing packaged translations `_ + - `Project translation best practices `_ + - `Sharing your translations `_ + +- Packaging + +(Combine the following topics where necessary) + + - `PPA `_ + - `BuilderSpecs `_ + - `BuildScores `_ + - `Building a source package for a PPA `_ - this is a reference as it is now but it also seems like a prerequisite for installing from a PPA. + - `Copying a PPA `_ - if you talk about steps of how to copy a PPA, this goes into how-to. Right now, it is about what is supported and what happens while copying a PPA + - `Deleting a PPA `_ - Same comment as for copying a PPA + - `More information `_ - these can be added as More information links at the end of relevant parent topics + - `Limitations `_ + - `Naming convention for daily builds `_ + - `FAQ `_ - This should be merged with reference and explanation content where necessary. + +- `Question life cycle `_ - this needs a corresponding explanation of what a question in LP is. If it is a short explanation, it can be the overview of this reference topic itself. +- `Guidelines for turning a bug into a question `_ +- `Settings and preferences `_ + +- Launchpad and community + + - `Get support `_ + - `Feedback on Launchpad `_ + - `Launchpad badges `_ + - `Launchpad policies `_ + - `Launchpad mentoring `_ + - `Project licenses `_ + - `Privacy and confidentiality `_ + +- `Project announcements `_ +- `Project groups `_ +- `SSH fingerprints `_ diff --git a/using-launchpad/tutorials/index.rst b/using-launchpad/tutorials/index.rst new file mode 100644 index 0000000..db39ec2 --- /dev/null +++ b/using-launchpad/tutorials/index.rst @@ -0,0 +1,19 @@ +:hide-toc: + +Tutorials +========= + +.. toctree:: + :maxdepth: 1 + + +The following are suggesting titles and topics for classification under tutorials: + +(These suggestion are based on content already available that had the potential to be a tutorial. LP team members should evaluate the necessity and usefulness of these topics if they were tutorials) + +- `Getting Started with Launchpad `_ + + - Also merge `New to launchpad `_ +- `Getting started with Launchpad's email interface `_ - This is a suggestion, It can be split into multiple how-to guides as well. +- `Getting started with source package builds `_ + - Also merge `Reverting daily build `_