-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #64 from pmatulis/steps-for-importing-starter-pack
Add sample git workflow for dedicated docs repo
- Loading branch information
Showing
1 changed file
with
21 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 [email protected]: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 [email protected]:canonical/alpha-docs | ||
git push -f upstream main | ||
Documentation in a code repository | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|