From 6494e46c45c287facbb864c756ba1b8e6d1f78bd Mon Sep 17 00:00:00 2001 From: Peter Matulis Date: Sun, 23 Jul 2023 21:49:41 -0400 Subject: [PATCH] Add sample git workflow for dedicated docs repo --- readme.rst | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/readme.rst b/readme.rst index f68518d5..a6aa8f5d 100644 --- a/readme.rst +++ b/readme.rst @@ -15,9 +15,28 @@ You can either create a standalone documentation project based on this repositor Standalone documentation repository ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -To create a standalone documentation repository, clone this starter pack repository, `update the configuration <#configure-the-documentation>`_, and then commit all files to your own documentation repository. +To create a standalone documentation repository, clone this starter pack +repository, `update the configuration <#configure-the-documentation>`_, and +then commit all files to the documentation repository. -You don't need to move any files, and you don't need to do any special configuration on Read the Docs. +You don't need to move any files, and you don't need to do any special +configuration on Read the Docs. + +Here is one way to do this for newly-created fictional docs repository +``canonical/alpha-docs``: + +.. code-block:: none + + git clone git@github.com:canonical/sphinx-docs-starter-pack alpha-docs + cd alpha-docs + rm -rf .git + git init + git branch -m main + UPDATE THE CONFIGURATION + git add -A + git commit -m "Import sphinx-docs-starter-pack" + git remote add upstream git@github.com:canonical/alpha-docs + git push -f upstream main Documentation in a code repository ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~