View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0001443 | Infrastructure | documentation | public | 2018-10-26 20:59 | 2020-05-22 11:32 |
| Reporter | jandd | Assigned To | jandd | ||
| Priority | normal | Severity | feature | Reproducibility | N/A |
| Status | needs work | Resolution | open | ||
| Platform | Default | OS | any | OS Version | any |
| Summary | 0001443: write a specification of what the current code in https://git.cacert.org/gitweb/?p=cacert.git does | ||||
| Description | There is no proper documentation of the existing code base. This documentation is needed to: - write a proper specification for a potential rewrite - implement unit tests - understand the code base which is especially important for anybody wanting to help | ||||
| Additional Information | Documentation should be in a version controlled repository. Human readable (HTML) exports should be generated and published automatically. (See infradocs.cacert.org/jenkins.cacert.org for an example how to do this). | ||||
| Tags | No tags attached. | ||||
|
|
I started a new repository at https://git.cacert.org/gitweb/?p=cacert-codedocs.git and setup a Jenkins job https://jenkins.cacert.org/job/cacert-codedocs/ that is triggered by pushes to the master branch of that repository. Pushes to this repository via git+ssh protocol are allowed to members of the git-doc group on git.cacert.org. |
|
|
I setup codedocs.cacert.org publishing on Jenkins and Apache VirtualHost configuration on web.cacert.org and webstatic.cacert.org. https://infradocs.cacert.org/ has been updated. I requested a DNS CNAME for codedocs.cacert.org to make the generated documentation available at https://codedocs.cacert.org/ I'll update the Jenkins job description when the CNAME has been setup. |
|
|
The code documentation repository is now mirrored to https://github.com/CAcertOrg/cacert-codedocs to encourage contributions. |
|
|
I'll try to get the whole www-directory documented. |
|
|
Is there a way to build a cross-reference-list? So one can see which file uses which file and is used by which file? |
|
|
It is possible to use the .. index: macros for cross references but I think it would be better to have something more code centric. I'll see if I find some free time to implement something like the IP address list, ssh key list or certificate list build for infradocs. |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2018-10-26 20:59 | jandd | New Issue | |
| 2018-10-26 20:59 | jandd | Assigned To | => jandd |
| 2018-10-26 22:30 | jandd | Status | new => needs work |
| 2018-10-26 22:30 | jandd | Note Added: 0005616 | |
| 2018-10-26 23:53 | jandd | Note Added: 0005617 | |
| 2018-10-29 21:27 | jandd | Note Added: 0005620 | |
| 2018-11-03 14:09 | GuKKDevel | Note Added: 0005646 | |
| 2018-11-04 13:13 | GuKKDevel | Note Added: 0005652 | |
| 2018-11-04 18:24 | jandd | Note Added: 0005653 |
