From 923495c192c581f1e90d21a5b225e2a9c9de5694 Mon Sep 17 00:00:00 2001 From: Kendall Nelson Date: Wed, 31 Jan 2018 14:30:29 -0800 Subject: [PATCH] Update Development & Migration Docs With the newer versions of tox the syntax has changed for how to run storyboard-db-manage, storyboard-api, etc. This patch makes the necessary updates to reflect those changes so that the commands work. Change-Id: I0e52a2816ae7a4f6406cf0aa71cbf988e24ba66f --- doc/source/install/development.rst | 8 ++++---- doc/source/migration.rst | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/source/install/development.rst b/doc/source/install/development.rst index 0175fec4..8ea1cdf2 100644 --- a/doc/source/install/development.rst +++ b/doc/source/install/development.rst @@ -80,12 +80,12 @@ Installing and Upgrading the API server 7. Upgrade DB schema to the latest version:: - tox -e venv "storyboard-db-manage --config-file ./etc/storyboard.conf upgrade head" + tox -e venv -- storyboard-db-manage --config-file ./etc/storyboard.conf upgrade head 8. Start the API server:: - tox -e venv "storyboard-api --config-file ./etc/storyboard.conf" + tox -e venv -- storyboard-api --config-file ./etc/storyboard.conf Installing the Javascript-based web client @@ -157,7 +157,7 @@ Optional steps: Seed database with base data 2. Enable the superusers in the database:: - tox -e venv "storyboard-db-manage --config-file ./etc/storyboard.conf load_superusers ./etc/superusers.yaml" + tox -e venv -- storyboard-db-manage --config-file ./etc/storyboard.conf load_superusers ./etc/superusers.yaml 3. If you want to quickly set up a set of projects and project groups in the @@ -167,7 +167,7 @@ Optional steps: Seed database with base data 4. Create the projects and projectgroups in the DB:: - tox -e venv "storyboard-db-manage --config-file ./etc/storyboard.conf load_projects ./etc/projects.yaml" + tox -e venv -- storyboard-db-manage --config-file ./etc/storyboard.conf load_projects ./etc/projects.yaml Optional steps: Set up the notifications daemon diff --git a/doc/source/migration.rst b/doc/source/migration.rst index 28b06ddb..3a706b1d 100644 --- a/doc/source/migration.rst +++ b/doc/source/migration.rst @@ -79,10 +79,10 @@ Test Migration You can do this with the following command:: - tox -e venv "storyboard-migrate + tox -e venv -- storyboard-migrate --config-file etc/storyboard.conf --from-project $PROJECT_IN_LAUNCHPAD - --to-project $PROJECT_IN_STORYBOARD" + --to-project $PROJECT_IN_STORYBOARD Here, `$PROJECT_IN_LAUNCHPAD` should be replaced by the name of the project in Launchpad, for example `monasca`. Similarly,