Skip to content

Commit

Permalink
docs(cookie): Add create github repository tutorial #130 (#131)
Browse files Browse the repository at this point in the history
Assist new users to set up the github repository and gather information
required to start a django-cookiecutter project.

closes #130
  • Loading branch information
imAsparky authored Oct 14, 2021
1 parent 41086cf commit e34afdf
Show file tree
Hide file tree
Showing 3 changed files with 103 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/source/tutorials/index-tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,6 @@ See below for a list of tutorials for Django Cookiecutter.
.. toctree::
:titlesonly:

tutorial-create-GH-repo
tutorial-create-django-project
tutorial-git-first-push
102 changes: 102 additions & 0 deletions docs/source/tutorials/tutorial-create-GH-repo.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
.. include:: /extras.rst.txt
.. highlight:: rst
.. index:: create-GH-repo ; Index

.. _create-GH-repo:
==========================
Create a GitHub Repository
==========================

|
See a list of steps below to get your GitHub Repository up
and running fast.


Pre-requisites
==============

A `GitHub <https://github.com/join>`_ account.


.. _create-GH-repo-tutorial:
Tutorial
========

Navigate to your GitHub account Repositories page and click New.

.. image:: ../_static/imgs/tutorials/github-repo-page.png
:alt: GitHub Repositories page

+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++


Fill in your new repository name. If you get a green tick, your chosen name
is available.

Fill in a short description.

.. image:: ../_static/imgs/tutorials/git-create-new-repo.png
:alt: Create a New Repository


Click `Create Repository`.


.. hint::

No need to choose any `Initialize this repository with:` options.

These are all generated for you when you create your package.

.. important::

The repository name and short description are prompts that you will
fill in when creating your django-cookiecutter.

.. code-block:: bash
"git_project_name":
"project_short_description":
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. _new-repo-cli-options:
New Repository Command Line Options
-----------------------------------

After clicking `Create Repository` you will be presented with these options.

.. image:: ../_static/imgs/tutorials/git-new-repo-cli-options.png
:alt: New Repository Command Line Options

Here you can choose how you want to get started and the commands are
conveniently described.

.. hint::

If you prefer, django-cookiecutter can set the local repository up for
you and get it ready for the first push, complete with a
`Conventional Commits <https://www.conventionalcommits.org/en/v1.0.0/>`_
style message.

The option used by django-cookiecutter to do this is a slightly
modified `…or create a new repository on the command line`.

To enable automatic local git setup, choose the default setting on the
following option.

.. code-block:: bash
"automatic_set_up_git_and_initial_commit": "y",
Whats next?
-----------

:ref:`Create a Django Cookiecutter Project<cookie-create-pkg>`.

or you can

Check out our other :ref:`Tutorials<tutorial-index>` for more information on
how to get the most out of your cookiecutter package.

0 comments on commit e34afdf

Please sign in to comment.