Skip to content

Commit

Permalink
Merge pull request #64 from pmatulis/steps-for-importing-starter-pack
Browse files Browse the repository at this point in the history
Add sample git workflow for dedicated docs repo
  • Loading branch information
Peter Matulis authored Jul 26, 2023
2 parents ad78df2 + 6494e46 commit dcc5977
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit dcc5977

Please sign in to comment.