Improve repository links
authorJan Dittberner <jandd@cacert.org>
Sun, 28 Oct 2018 09:14:12 +0000 (10:14 +0100)
committerJan Dittberner <jandd@cacert.org>
Sun, 28 Oct 2018 09:14:12 +0000 (10:14 +0100)
- 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

source/building.rst
source/conf.py
source/index.rst
source/structure.txt

index f07f72d..e3faeae 100644 (file)
@@ -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::
 
index f3750f4..266ca3e 100644 (file)
@@ -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)
index e1abc94..fbbddc9 100644 (file)
@@ -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:
index c4f5993..9d6bfc6 100644 (file)
 │   │   ├── version2.sh
 │   │   ├── version3.sh
 │   │   ├── version4.sh
-│   │   └── version5.sh
+│   │   ├── version5.sh
+│   │   └── version6.sh
 │   ├── DumpWeakCerts.pl
 │   ├── findexp3.pl
 │   ├── findnull.pl
     ├── 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
     ├── verify.php
     └── wot.php
 
-36 directories, 548 files
+37 directories, 567 files