Skip to content

Commit

Permalink
DOCS: Removed broken git links. (#5569)
Browse files Browse the repository at this point in the history
* removed broken git links.

* added whatsnew
  • Loading branch information
tkknight authored Nov 8, 2023
1 parent e0850eb commit 9907bce
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 21 deletions.
1 change: 0 additions & 1 deletion docs/src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,6 @@ def _dotv(version):
"https://docs.github.com",
"https://github.com",
"http://www.personal.psu.edu/cab38/ColorBrewer/ColorBrewer_updates.html",
"http://schacon.github.com/git",
"http://scitools.github.com/cartopy",
"http://www.wmo.int/pages/prog/www/DPFS/documents/485_Vol_I_en_colour.pdf",
"https://software.ac.uk/how-cite-software",
Expand Down
11 changes: 5 additions & 6 deletions docs/src/developers_guide/gitwash/development_workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ what the changes in the branch are for. For example ``add-ability-to-fly``, or
git checkout my-new-feature

Generally, you will want to keep your feature branches on your public github_
fork of `iris`_. To do this, you `git push`_ this new branch up to your
fork of `iris`_. To do this, you ``git push`` this new branch up to your
github repo. Generally (if you followed the instructions in these pages, and by
default), git will have a link to your github repo, called ``origin``. You push
up to your own repo on github with::
Expand Down Expand Up @@ -108,7 +108,7 @@ In More Detail
--------------

#. Make some changes
#. See which files have changed with ``git status`` (see `git status`_).
#. See which files have changed with ``git status``.
You'll see a listing like this one::

# On branch ny-new-feature
Expand All @@ -124,16 +124,15 @@ In More Detail
# INSTALL
no changes added to commit (use "git add" and/or "git commit -a")

#. Check what the actual changes are with ``git diff`` (`git diff`_).
#. Add any new files to version control ``git add new_file_name`` (see
`git add`_).
#. Check what the actual changes are with ``git diff``.
#. Add any new files to version control ``git add new_file_name``.
#. To commit all modified files into the local copy of your repo, do
``git commit -am 'A commit message'``. Note the ``-am`` options to
``commit``. The ``m`` flag just signals that you're going to type a
message on the command line. The ``a`` flag will automatically stage
all files that have been modified and deleted.
#. To push the changes up to your forked repo on github, do a ``git
push`` (see `git push`_).
push``.


Testing Your Changes
Expand Down
14 changes: 0 additions & 14 deletions docs/src/developers_guide/gitwash/git_links.inc
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,6 @@
.. _github help: https://help.github.com
.. _git documentation: https://git-scm.com/docs

.. _git clone: http://schacon.github.com/git/git-clone.html
.. _git checkout: http://schacon.github.com/git/git-checkout.html
.. _git commit: http://schacon.github.com/git/git-commit.html
.. _git push: http://schacon.github.com/git/git-push.html
.. _git pull: http://schacon.github.com/git/git-pull.html
.. _git add: http://schacon.github.com/git/git-add.html
.. _git status: http://schacon.github.com/git/git-status.html
.. _git diff: http://schacon.github.com/git/git-diff.html
.. _git log: http://schacon.github.com/git/git-log.html
.. _git branch: http://schacon.github.com/git/git-branch.html
.. _git remote: http://schacon.github.com/git/git-remote.html
.. _git rebase: http://schacon.github.com/git/git-rebase.html
.. _git config: http://schacon.github.com/git/git-config.html

.. _linux git workflow: http://www.mail-archive.com/[email protected]/msg39091.html

.. |emdash| unicode:: U+02014
2 changes: 2 additions & 0 deletions docs/src/whatsnew/latest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ This document explains the changes made to Iris for this release
links shown. Also improved how the warning banner is implemented.
(:pull:`5505` and :pull:`5508`)

#. `@tkknight`_ removed broken git links. (:pull:`5569`)


💼 Internal
===========
Expand Down

0 comments on commit 9907bce

Please sign in to comment.