This started as a git svn clone of http://svn.cacert.org/CAcert/Policies/ This is not an official repository yet, just a base for discussion
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Go to file
Kim Nilsson 55a8ccbaca Merge pull request 'Add a contribution guide' (#5) from contribution-guide into main
Reviewed-on: #5
3 months ago
Agreements policy images 11 years ago
OrganisationAssurancePolicy add DRAFT reference, 11 years ago
code simpler shell script 14 years ago
images policy images 11 years ago
.gitattributes Add .gitignore and .gitattributes 4 months ago
.gitignore Add .gitignore and .gitattributes 4 months ago
AssurancePolicy.html shifting images and dropping XHTML checker icon, only 14 years ago
CAcertBookshelf.html added bookshelf 16 years ago
CAcertBookshelf.pdf added bookshelf 16 years ago
CAcertBookshelf.xml Added DocBook 5.0 bookshelf, policy manual and OA subpolicy for europe 16 years ago
CAcertCommunityAgreement_20140708.html git-svn-id: http://svn.cacert.org/CAcert/Policies@2566 14b1bab8-4ef6-0310-b690-991c95c89dfd 10 years ago
CAcertPolicyManual.html added policy manuals 16 years ago
CAcertPolicyManual.pdf added policy manuals 16 years ago
CAcertPolicyManual.xml added policy manuals 16 years ago
CertificationPracticeStatement.html Converted existing CPS 8 months ago
CertificationPracticeStatement.md Converted existing CPS 8 months ago
ConfigurationControlSpecification.html shifting images and dropping XHTML checker icon, only 14 years ago
ControlledDocumentList.html updated ControlledDocumentList from policy officer 10 years ago
DesertSeedingPolicy.html written by PD, access still not available to others 15 years ago
DisputeResolutionPolicy-p20130116.html DRP update for transfer to www.cacert.org/policy including recent policy decisions update: p20130116 11 years ago
DisputeResolutionPolicy.html p20130116 carried 12 years ago
DisputeResolutionPolicy_p20121213.html PoP link update according to https://bugs.cacert.org/view.php?id=1131 12 years ago
DocumentsPolicy.html Some minor changes to bring it into line with later decisions: 17 years ago
Makefile added bookshelf 16 years ago
NucleusAssurancePolicy.html added, as the previous line has some variation possible 11 years ago
Policy.odt Added policy doc as initiated by Ian. Now commented by teus. 16 years ago
PolicyOnFoundations.html moving these all into Policies so that they can be managed from 17 years ago
PolicyOnGovernance.html shifting images and dropping XHTML checker icon, only 14 years ago
PolicyOnJuniorAssurersMembers.html https://wiki.cacert.org/PolicyDecisions#p20130222 11 years ago
PolicyOnPolicy.html reference to last fix 20130310 (removing /wiki/ from links) 11 years ago
PrivacyPolicy.php moving these all into Policies so that they can be managed from 17 years ago
PrivacyPolicy.txt Changed address to that indicated by public officer. 12 years ago
README.md Add a section about MarkDown 4 months ago
RemoteAssurancePolicy.html images only 14 years ago
RemoteVerificationPolicy.html shifting images and dropping XHTML checker icon, only 14 years ago
SecurityPolicy.html URLs only 14 years ago
TTPAssistedAssurancePolicy-20130211.html TTP-assisted-assurance policy transfer from SVN to main CAcert website 12 years ago
TTPAssistedAssurancePolicy.html ug 14 years ago
TVerifyAssurancePolicy.html git-svn-id: http://svn.cacert.org/CAcert/Policies@1495 14b1bab8-4ef6-0310-b690-991c95c89dfd 15 years ago
WebDataPrivacyPolicy.html add WebDataPrivacyPolicy 10 years ago
X509ImplementationPolicy.html shifting images and dropping XHTML checker icon, only 14 years ago
policy_group_decisions_summary.html updated with 2 decisions 11 years ago
transtab.utf Added table for ISO transliteration to simples coding. 16 years ago

README.md

The CAcert policy repository

This repository contains work in progress policy documents for CAcert.

Getting started using Git

We use Git for working with this repository. Git is a free and open source distributed version control system.

Installing Git

To work with Git you need a piece of client software. Git is available for all major operating systems. On Linux systems Git is available from your distribution's package manager and can be installed using something like

# install Git on Debian based systems
sudo apt install git

or

# install Git on Fedora based systems
sudo dnf install git

For Windows or MacOS you should use the binary installers from the Git Download Page.

First steps with Git

Open a Terminal window (Linux and MacOS have default terminal applications, on Windows you might want to use the Git bash that comes bundled with the Git client installation).

Tell Git who you are and what email address you would like to use. This information will be put in commits you will do later.

# Tell Git who you are
git config --global user.name "Your Full Name"
git config --global user.email "yourname@cacert.org"

Get a clone of this repository

A local working copy is called a clone in Git terminology. Run

cd $HOME/where-your-projects-live
git clone https://code.cacert.org/cacert/cacert-policies.git

to get your local copy.

Update your local copy

If you have not worked on your copy for a while you can update it with the following commands:

cd $HOME/where-your-projects-live/cacert-policies
git pull -r

Making changes

If you want to make changes to the content of the repository, working on a Git branch is recommended. You can have multiple branches in your local Git clone and can switch between these.

cd $HOME/where-your-projects-live/cacert-policies
# create a branch for your work
git checkout -b some-topic-you-will-work-on

You can then make changes in the files in your working copy as you like. You can also add new files. When you are satisfied with what you have, you can add the changes to Git's staging area (in some documents this is also called the index):

git add .

You can show the status of your local copy using

git status

If you would like to remove a file you can run

git rm the-file-you-do-not-want-anymore

To publish your changes for review you need to create a commit and push your branch to the origin repository.

Please make yourself familiar with how to write good Git commit messages. It will make the life of your future self and of other contributors a lot better.

# Make a commit
git commit -m "Add inspiration quotes

Fixes #1"
# Push your branch to the origin repository
git push origin some-topic-you-will-work-on

You may repeat the edit, commit, push cycle multiple times and finally create a pull request by clicking on the link in the output of the git push command.

Switching to another branch

If you wait for a review on your pull request or want to work on a different topic you can switch to the main branch and start a new branch from there as described above.

git switch main

Git comes with a very comprehensive built-in help. Help can be retrieved using

# get help for Git as a whole
git help
# get help for a specific command, in this case git switch
git help switch

If you would like to dive deeper into Git you can read the free Pro Git book on the Git website.

Markdown

New documents should be written in Markdown syntax. Markdowns goal is to provide a human readable and writable syntax that can easily be transformed to representations in several output formats.

We use the CommonMark variant of Markdown with the table extension. CommonMark is well supported in Markdown libraries and conversion tools. The code.cacert.org system can render CommonMark Markdown documents to HTML allowing for easily accessible previews.

To preview Markdown in several formats (HTML, PDF, Office documents) you can use Pandoc which is packaged for multiple Linux distributions and has installers for Windows and MacOS.

As Markdown is a plain text format you may use any text editor like Vim, notepad++ and a lot of alternatives.

If you prefer a live preview and some more assistance you may use a more heavyweight tool like Visual Studio Code or any of the JetBrains IDEs like PyCharm.