opendev
/
infra-manual
Code Issues Proposed changes

Retirement: Make clearer that we need README.rst 

The redirects from docs.o.o are to README.rst, not README.md - always
speak about README.rst in the retirment instructions.

Change-Id: I50f3e677d62d94b2ff791531290c3e73c3f86109
This commit is contained in:
Andreas Jaeger 2020-06-20 17:10:21 +02:00
parent 1957a16952
commit 5b9a2406b0
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/drivers.rst
View File

@ -361,7 +361,7 @@ Double check that all dot files (such as ``.gitignore`` and
Take care to remove all files other than ``README.rst`` and
``.gitreview``.
Replace the contents of the README with a message such as this::
Replace the contents of the ``README.rst`` with a message such as this::
This project is no longer maintained.
@ -386,7 +386,7 @@ who continuously deploy the software as well as users who track
changes to the repository to notice the retirement. While this may be
disruptive, it is generally considered better than continuing to
deploy unmaintained software. Potential contributors who may not have
otherwise read the README will in this case, as it is the only file in
otherwise read the README.rst will in this case, as it is the only file in
the repository.
Step 3: Remove Project from Infrastructure Systems