nik/easyrsa
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Stylistic updates to documentation.

Browse Source 
Add markdown links to documents referred to in README.md and
doc/EasyRSA-Readme.md

Signed-off-by: Junichi Uekawa <dancer@debian.org>
Signed-off-by: Richard T Bonhomme <tincantech@protonmail.com>
This commit is contained in:
Junichi Uekawa 2023-07-29 17:14:49 +09:00 committed by Richard T Bonhomme
parent 669ee43ea1
commit 14e26c7473
No known key found for this signature in database
GPG Key ID: 2D767DB92FB6C246
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -13,7 +13,7 @@ GitHub. Releases are also available as source checkouts using named tags.
# Documentation # Documentation
For 3.x project documentation and usage, see the [README.quickstart.md](README.quickstart.md) file or For 3.x project documentation and usage, see the [README.quickstart.md](README.quickstart.md) file or
the more detailed docs under the doc/ directory. The .md files are in Markdown the more detailed docs under the [doc/](doc/) directory. The .md files are in Markdown
format and can be converted to html files as desired for release packages, or format and can be converted to html files as desired for release packages, or
read as-is in plaintext. read as-is in plaintext.

12
doc/EasyRSA-Readme.md
View File

@ -4,7 +4,7 @@ Easy-RSA 3 Documentation Readme
This document explains how Easy-RSA 3 and each of its assorted features work. This document explains how Easy-RSA 3 and each of its assorted features work.
If you are looking for a quickstart with less background or detail, an If you are looking for a quickstart with less background or detail, an
implementation-specific How-to or Readme may be available in this (the `doc/`) implementation-specific How-to or Readme may be available in this (the [`doc/`](./))
directory. directory.
Easy-RSA Overview Easy-RSA Overview
@ -12,7 +12,7 @@ Easy-RSA Overview
Easy-RSA is a utility for managing X.509 PKI, or Public Key Infrastructure. A Easy-RSA is a utility for managing X.509 PKI, or Public Key Infrastructure. A
PKI is based on the notion of trusting a particular authority to authenticate a PKI is based on the notion of trusting a particular authority to authenticate a
remote peer; for more background on how PKI works, see the `Intro-To-PKI` remote peer; for more background on how PKI works, see the [Intro-To-PKI](Intro-To-PKI.md)
document. document.
The code is written in platform-neutral POSIX shell, allowing use on a wide The code is written in platform-neutral POSIX shell, allowing use on a wide
@ -98,13 +98,13 @@ Any of these options can appear before the command as required as shown below:
./easyrsa [options] command [ cmd-opts ] ./easyrsa [options] command [ cmd-opts ]
For experts, additional configuration with env-vars and custom X.509 extensions For experts, additional configuration with env-vars and custom X.509 extensions
is possible. Consult the `EasyRSA-Advanced` documentation for details. is possible. Consult the [EasyRSA-Advanced](EasyRSA-Advanced.md) documentation for details.
Getting Started: The Basics Getting Started: The Basics
--------------------------- ---------------------------
Some of the terms used here will be common to those familiar with how PKI works. Some of the terms used here will be common to those familiar with how PKI works.
Instead of describing PKI basics, please consult the document `Intro-To-PKI` if Instead of describing PKI basics, please consult the document [Intro-To-PKI](Intro-To-PKI.md) if
you need a more basic description of how a PKI works. you need a more basic description of how a PKI works.
#### Creating an Easy-RSA PKI #### Creating an Easy-RSA PKI
@ -125,8 +125,8 @@ you need a more basic description of how a PKI works.
An Easy-RSA PKI contains the following directory structure: An Easy-RSA PKI contains the following directory structure:
* private/ - dir with private keys generated on this host * `private/` - dir with private keys generated on this host
* reqs/ - dir with locally generated certificate requests (for a CA imported * `reqs/` - dir with locally generated certificate requests (for a CA imported
requests are stored here) requests are stored here)
In a clean PKI no files exist yet, just the bare directories. Commands called In a clean PKI no files exist yet, just the bare directories. Commands called