Skip to content

Commit

Permalink
New readthedocs location for keylime
Browse files Browse the repository at this point in the history
After the move from the keylime-docs repo into the docs/ dir of the main
repo, we need to update readthedocs to point to the new docs which will
also follow the version tags.

Signed-off-by: Michael Peters <mpeters@redhat.com>
  • Loading branch information
mpeters committed Sep 20, 2022
1 parent 8f4bcb6 commit bd1a662
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ to make via an [issue](https://github.com/keylime/keylime/issues) or email to th
outlining the fix or feature.
2. Fork the keylime repository to your own github account and clone it locally.
3. Hack on your changes.
4. Update the README.md or documentation in [keylime-docs](https://github.com/keylime/keylime-docs)
4. Update the README.md or documentation in the `docs/` directory
with details of changes to any interface, this includes new environment
variables, exposed ports, useful file locations, CLI parameters and
new or changed configuration values.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Keylime

[![Slack CNCF chat](https://img.shields.io/badge/Chat-CNCF%20Slack-informational)](https://cloud-native.slack.com/archives/C01ARE2QUTZ)
[![Docs Status](https://readthedocs.org/projects/keylime-docs/badge/?version=latest)](https://keylime-docs.readthedocs.io/en/latest/?badge=latest)
[![Docs Status](https://readthedocs.org/projects/keylime/badge/?version=latest)](https://keylime.readthedocs.io/en/latest/?badge=latest)

![keylime](docs/keylime.png?raw=true "Title")

Expand Down
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ help:
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# keylime-docs

[![Documentation Status](https://readthedocs.org/projects/keylime-docs/badge/?version=latest)](https://keylime-docs.readthedocs.io/en/latest/?badge=latest)
[![Documentation Status](https://readthedocs.org/projects/keylime/badge/?version=latest)](https://keylime.readthedocs.io/en/latest/?badge=latest)

All Keylime documentation is formatted in [reStructuredText](https://en.wikipedia.org/wiki/ReStructuredText)

Expand Down
4 changes: 2 additions & 2 deletions keylime.conf
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ agent_mtls_private_key =
agent_mtls_private_key_pw =

# Database URL Configuration
# See this document https://keylime-docs.readthedocs.io/en/latest/installation.html#database-support
# See this document https://keylime.readthedocs.io/en/latest/installation.html#database-support
# for instructions on using different database configurations.
# There are two options for the specification of the database connection configuration.
# 1) A tuple of parameters (e.g., database_drivername, database_username, database_password)
Expand Down Expand Up @@ -564,7 +564,7 @@ registrar_private_key_pw = default
check_client_cert = True

# Database URL Configuration
# See this document https://keylime-docs.readthedocs.io/en/latest/installation.html#database-support
# See this document https://keylime.readthedocs.io/en/latest/installation.html#database-support
# for instructions on using different database configurations.
# There are two options for the specification of the database connection configuration.
# 1) A tuple of parameters (e.g., database_drivername, database_username, database_password)
Expand Down
2 changes: 1 addition & 1 deletion scripts/templates/2.0/registrar.j2
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ server_cert = {{ registrar.server_cert }}
trusted_client_ca = {{ registrar.trusted_client_ca }}

# Database URL Configuration
# See this document https://keylime-docs.readthedocs.io/en/latest/installation.html#database-support
# See this document https://keylime.readthedocs.io/en/latest/installation.html#database-support
# for instructions on using different database configurations.
#
# An example of database_url value for using sqlite:
Expand Down
2 changes: 1 addition & 1 deletion scripts/templates/2.0/verifier.j2
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ client_cert = {{ verifier.client_cert }}
trusted_server_ca = {{ verifier.trusted_server_ca }}

# Database URL Configuration
# See this document https://keylime-docs.readthedocs.io/en/latest/installation.html#database-support
# See this document https://keylime.readthedocs.io/en/latest/installation.html#database-support
# for instructions on using different database configurations.
#
# An example of database_url value for using sqlite:
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ license_file = LICENSE
readme = README.md
project_urls =
Source = https://github.com/keylime/keylime
Documentation = https://keylime-docs.readthedocs.io/en/latest/
Documentation = https://keylime.readthedocs.io/en/latest/

classifiers =
Environment :: Console
Expand Down

0 comments on commit bd1a662

Please sign in to comment.