diff --git a/doc/source/dev/faq.rst b/doc/source/dev/faq.rst new file mode 100644 index 0000000000..1277bfaf30 --- /dev/null +++ b/doc/source/dev/faq.rst @@ -0,0 +1,28 @@ +.. _faq: + +========================================== +Developer FAQ (frequently asked questions) +========================================== + +Here are some answers to frequently-asked questions from IRC and +elsewhere. + +.. contents:: + :local: + :depth: 2 + + +How do I… +========= + +…create a migration script template? +------------------------------------ + +Using the ``alembic revision`` command, e.g:: + + $ cd ironic/ironic/db/sqlalchemy + $ alembic revision -m "create foo table" + +For more information see the `alembic documentation`_. + +.. _`alembic documentation`: https://alembic.readthedocs.org/en/latest/tutorial.html#create-a-migration-script diff --git a/doc/source/index.rst b/doc/source/index.rst index 934a5bd57e..0d265b78bb 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -67,6 +67,11 @@ Introduction dev/dev-quickstart dev/vendor-passthru +.. toctree:: + :maxdepth: 1 + + dev/faq + API References --------------