Skip to content

Commit

Permalink
Guide fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
idomic committed Jan 15, 2022
1 parent 731a4d9 commit d85b081
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
16 changes: 16 additions & 0 deletions doc/user-guide/scaffold.rst
Expand Up @@ -9,6 +9,22 @@ You can quickly create new projects using the ``scaffold`` command:
After running it, type a name for your project and press enter. The command will create a pre-configured project with a sample pipeline.

By adding the ``--empty`` flag to scaffold you can create an empty pipeline - this will scaffold an empty pipeline.yaml:

.. code-block:: console
ploomber scaffold --empty
Similar to the command above without the ``--empty`` flag, you'll need to type your project name and press enter.

By adding the ``-e`` or ``--entry-point`` you can specific a custom name to your pipeline.yaml (redirect to a different .yaml or location).
This will create a pipeline from the specified entry point:

.. code-block:: console
ploomber scaffold --entry-point
By default, ``scaffold`` adds a ``requirements.txt`` file to use with pip. If you want to use conda:

.. code-block:: console
Expand Down
2 changes: 1 addition & 1 deletion doc/user-guide/templates.rst
Expand Up @@ -96,7 +96,7 @@ Starting projects from scratch
------------------------------

If no template suits your needs, use the ``ploomber scaffold`` command
to create a barebones project. :doc:`Click here to learn how to scaffold projects </user-guide/scaffold>`.
to create a clean slate project. :doc:`Click here to learn how to scaffold projects </user-guide/scaffold>`.

``ploomber scaffold`` also comes with utilities to modify existing pipelines,
so can use it to modify any of the templates.

0 comments on commit d85b081

Please sign in to comment.