7 **The github repository is only being used as a source for readthedocs.**
8 **There should be no reason for the typical developer to use this repository.**
9 **It should only be used by a document developer.**
14 This section will cover how to fork your own branch of the `fdioDocs/vpp-docs <https://github.com/fdioDocs/vpp-docs>`_ repository, clone that repo locally to your computer, make changes to it, and how to issue a pull request when you want your changes to be reflected on the main repo.
18 Forking your own branch
19 _______________________
21 In your browser, navigate to the repo you want to branch off of. In this case, the `fdioDocs/vpp-docs <https://github.com/fdioDocs/vpp-docs>`_ repo. At the top right of the page you should see this:
23 .. figure:: /_images/ForkButtons.png
24 :alt: Figure: Repository options on Github
32 Click on "Fork", and then a pop-up should appear where you should then click your Github username. Once this is done, it should automatically take you to the Github page where your new branch is located, just like in the image below.
34 .. figure:: /_images/usernameFork.png
35 :alt: Figure: Your own branch of the main repo on Github
40 Now your **own branch** can be **cloned** to your computer using the URL (https://github.com/YOURUSERNAME/vpp-docs) of the Github page where your branch is located.
43 Creating a local repository
44 ___________________________
46 Now that you have your own branch of the main repository on Github, you can store it locally on your computer. In your shell, navigate to the directory where you want to store your branch/repo. Then execute:
48 .. code-block:: console
50 $ git clone https://github.com/YOURUSERNAME/vpp-docs
52 This will create a directory on your computer named **vpp-docs**, the name of the repo.
54 Now that your branch is on your computer, you can modify and build files however you wish.
56 If you are not on the master branch, move to it.
58 .. code-block:: console
63 Keeping your files in sync with the main repo
64 _____________________________________________
66 The following talks about remote branches, but keep in mind that there are currently *two* branches, your local "master" branch (on your computer), and your remote "origin or origin/master" branch (the one you created using "Fork" on the Github website).
68 You can view your *remote* repositories with:
70 .. code-block:: console
74 At this point, you may only see the remote branch that you cloned from.
76 .. code-block:: console
78 Macintosh:docs Andrew$ git remote -v
79 origin https://github.com/a-olechtchouk/vpp-docs (fetch)
80 origin https://github.com/a-olechtchouk/vpp-docs (push)
82 Now you want to create a new remote repository of the main vpp-docs repo (naming it upstream).
84 .. code-block:: console
86 $ git remote add upstream https://github.com/fdioDocs/vpp-docs
89 You can verify that you have added a remote repo using the previous **git remote -v** command.
91 .. code-block:: console
94 origin https://github.com/a-olechtchouk/vpp-docs (fetch)
95 origin https://github.com/a-olechtchouk/vpp-docs (push)
96 upstream https://github.com/fdioDocs/vpp-docs (fetch)
97 upstream https://github.com/fdioDocs/vpp-docs (push)
100 If there have been any changes to files in the main repo (hopefully not the same files you were working on!), you want to make sure your local branch is in sync with them.
102 To do so, fetch any changes that the main repo has made, and then merge them into your local master branch using:
104 .. code-block:: console
107 $ git merge upstream/master
110 .. note:: **This is optional, so don't do these commands if you just want one local branch!!!**
112 You may want to have multiple branches, where each branch has its own different features, allowing you to have multiple pull requests out at a time. To create a new local branch:
114 .. code-block:: shell
116 $ git checkout -b cleanup-01
122 Now you can redo the previous steps for "Keeping your files in sync with the main repo" for your newly created local branch, and then depending on which branch you want to send out a pull reqest for, proceed below.
125 Pushing to your branch
126 ______________________
128 Now that your files are in sync, you want to add modified files, commit, and push them from *your local branch* to your *personal remote branch* (not the main fdioDocs repo).
130 To check the status of your files, run:
132 .. code-block:: console
137 In the output example below, I deleted gettingsources.rst, made changes to index.rst and pushingapatch.rst, and have created a new file called buildingrst.rst.
139 .. code-block:: console
141 Macintosh:docs Andrew$ git status
143 Your branch is up-to-date with 'origin/master'.
144 Changes to be committed:
145 (use "git reset HEAD <file>..." to unstage)
147 deleted: tasks/writingdocs/gettingsources.rst
149 Changes not staged for commit:
150 (use "git add <file>..." to update what will be committed)
151 (use "git checkout -- <file>..." to discard changes in working directory)
153 modified: tasks/writingdocs/index.rst
154 modified: tasks/writingdocs/pushingapatch.rst
157 (use "git add <file>..." to include in what will be committed)
159 tasks/writingdocs/buildingrst.rst
163 To add files (use **git add -A** to add all modified files):
165 .. code-block:: console
167 $ git add FILENAME1 FILENAME2
169 Commit and push using:
171 .. code-block:: console
173 $ git commit -m 'A descriptive commit message for two files.'
175 Push your changes for the branch where your changes were made
177 .. code-block:: console
179 $ git push origin <branch name>
181 Here, your personal remote branch is "origin" and your local branch is "master".
185 Using **git commit** after adding your files saves a "Snapshot" of them, so it's very hard to lose your work if you *commit often*.
189 Initiating a pull request (Code review)
190 _______________________________________
192 Once you've pushed your changes to your remote branch, go to your remote branch on Github (https://github.com/YOURUSERNAME/vpp-docs), and click on "New pull request".
194 .. figure:: /_images/issuePullReq.png
195 :alt: Figure: Your own branch of the main repo on Github
199 This will bring you to a "Comparing changes" page. Click "Create new pull request".
201 .. figure:: /_images/createNewPullReq.png
209 Which will open up text fields to add information to your pull request.
211 .. figure:: /_images/examplePullReq.png
216 Then finally click "Create pull request" to complete the pull request.
218 Your documents will be reviewed. To this same branch make the changes requested from the review and then push your new changes. There is no need to create another pull request.
220 .. code-block:: console
222 $ git commit -m 'A descriptive commit message for the new changes'
223 $ git push origin <branch name>
226 Additional Git commands
227 _______________________
229 You may find some of these Git commands useful:
231 Use **git diff** to quickly show the file changes and repo differences of your commits.
233 Use **git rm FILENAME** to stop tracking a file and to remove it from your remote branch and local directory. Use flag **-r** to remove folders/directories. E.g (**git rm -r oldfolder**)
236 .. _fdioDocs: https://github.com/fdioDocs/vpp-docs