summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJan Dittberner <jandd@cacert.org>2018-10-28 10:14:12 +0100
committerJan Dittberner <jandd@cacert.org>2018-10-28 10:14:12 +0100
commit62079ed0cadc3f81ee763cc9b255c6631639b5b7 (patch)
treed52a6b18f558f30a8d125aed0a362f1458b12d9b
parent8ba1692ba7e8d572aa1f7fddd9b89d4316399ad6 (diff)
downloadcacert-codedocs-62079ed0cadc3f81ee763cc9b255c6631639b5b7.tar.gz
cacert-codedocs-62079ed0cadc3f81ee763cc9b255c6631639b5b7.tar.xz
cacert-codedocs-62079ed0cadc3f81ee763cc9b255c6631639b5b7.zip
Improve repository links
- add extlinks configuration for cacertgit and github - use extlinks for repository links - explain the relationship of the CAcert and Github repositories - update the structure.txt to the current release branch
-rw-r--r--source/building.rst3
-rw-r--r--source/conf.py3
-rw-r--r--source/index.rst5
-rw-r--r--source/structure.txt30
4 files changed, 32 insertions, 9 deletions
diff --git a/source/building.rst b/source/building.rst
index f07f72d..e3faeae 100644
--- a/source/building.rst
+++ b/source/building.rst
@@ -10,8 +10,7 @@ Getting the documentation source
--------------------------------
The documentation is available from the git repository cacert-codedocs on
-git.cacert.org. You can browse the `repository
-<http://git.cacert.org/gitweb/?p=cacert-codedocs.git;a=summary>`_ via gitweb.
+git.cacert.org. You can browse the :cacertgit:`cacert-codedocs` via gitweb.
You can clone the repository anonymously by executing::
diff --git a/source/conf.py b/source/conf.py
index f3750f4..266ca3e 100644
--- a/source/conf.py
+++ b/source/conf.py
@@ -220,9 +220,10 @@ todo_include_todos = True
extlinks = {
'wiki': ('https://wiki.cacert.org/%s', 'Wiki '),
+ 'cacertgit': ('https://git.cacert.org/gitweb/?p=%s.git', 'CAcert Git repository '),
+ 'github': ('https://github.com/CAcertOrg/%s', 'Github repository '),
}
-
def cacert_bug(name, rawtext, text, lineno, inliner, options={}, content=[]):
try:
bugnum = int(text)
diff --git a/source/index.rst b/source/index.rst
index e1abc94..fbbddc9 100644
--- a/source/index.rst
+++ b/source/index.rst
@@ -7,12 +7,15 @@ CAcert code documentation
=========================
This is a work in progress documentation of the CAcert web application source
-code at https://git.cacert.org/gitweb/?p=cacert.git.
+code in the `release` branch of the :cacertgit:`cacert-devel`.
The goal is to document the existing code base to give insight into its
functionality and to support writing a specification for a potential
reimplementation.
+The code repository is mirrored to the :github:`cacert-devel` to encourage
+contribution. The canonical repository is the :cacertgit:`cacert-devel` though.
+
.. toctree::
:maxdepth: 2
:caption: Contents:
diff --git a/source/structure.txt b/source/structure.txt
index c4f5993..9d6bfc6 100644
--- a/source/structure.txt
+++ b/source/structure.txt
@@ -193,7 +193,8 @@
│   │   ├── version2.sh
│   │   ├── version3.sh
│   │   ├── version4.sh
-│   │   └── version5.sh
+│   │   ├── version5.sh
+│   │   └── version6.sh
│   ├── DumpWeakCerts.pl
│   ├── findexp3.pl
│   ├── findnull.pl
@@ -365,17 +366,36 @@
├── logos.php
├── news.php
├── policy
+ │   ├── AssurancePolicy.html
│   ├── AssurancePolicy.php
+ │   ├── CAcertCommunityAgreement.html
│   ├── CAcertCommunityAgreement.php
- │   ├── cacert-draft.png
+ │   ├── CertificationPracticeStatement.html
│   ├── CertificationPracticeStatement.php
+ │   ├── ConfigurationControlSpecification.html
+ │   ├── DisputeResolutionPolicy.html
│   ├── DisputeResolutionPolicy.php
+ │   ├── images
+ │   │   ├── cacert-draft.png
+ │   │   ├── cacert-policy.png
+ │   │   ├── valid-html401-blue.png
+ │   │   ├── valid-html50-blue.png
+ │   │   └── valid-xhtml11-blue.png
│   ├── index.php
- │   ├── NRPDisclaimerAndLicence.php
+ │   ├── OrganisationAssurancePolicy_Australia.html
+ │   ├── OrganisationAssurancePolicy_Europe.html
+ │   ├── OrganisationAssurancePolicy_Germany.html
+ │   ├── OrganisationAssurancePolicy.html
│   ├── OrganisationAssurancePolicy.php
+ │   ├── PolicyOnJuniorAssurersMembers.html
+ │   ├── PolicyOnPolicy.html
│   ├── PolicyOnPolicy.php
│   ├── PrivacyPolicy.html
- │   └── RootDistributionLicense.php
+ │   ├── PrivacyPolicy.php
+ │   ├── RootDistributionLicense.html
+ │   ├── RootDistributionLicense.php
+ │   ├── SecurityPolicy.html
+ │   └── TTPAssistedAssurancePolicy.html
├── rss.php
├── sealgen.php
├── siteimages
@@ -584,4 +604,4 @@
├── verify.php
└── wot.php
-36 directories, 548 files
+37 directories, 567 files