Skip to content

Commit

Permalink
Stylistic updates to documentation.
Browse files Browse the repository at this point in the history
When I am reading on the web page I would like links to documents
referred.

Signed-off-by: Junichi Uekawa <[email protected]>
  • Loading branch information
dancerj committed Jul 29, 2023
1 parent 669ee43 commit a2f5db3
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ GitHub. Releases are also available as source checkouts using named tags.
# Documentation

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
read as-is in plaintext.

Expand Down
12 changes: 6 additions & 6 deletions doc/EasyRSA-Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ Easy-RSA 3 Documentation Readme
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
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.

Easy-RSA Overview
-----------------

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
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.

The code is written in platform-neutral POSIX shell, allowing use on a wide
Expand Down Expand Up @@ -98,13 +98,13 @@ Any of these options can appear before the command as required as shown below:
./easyrsa [options] command [ cmd-opts ]

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
---------------------------

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.

#### Creating an Easy-RSA PKI
Expand All @@ -125,8 +125,8 @@ you need a more basic description of how a PKI works.

An Easy-RSA PKI contains the following directory structure:

* private/ - dir with private keys generated on this host
* reqs/ - dir with locally generated certificate requests (for a CA imported
* `private/` - dir with private keys generated on this host
* `reqs/` - dir with locally generated certificate requests (for a CA imported
requests are stored here)

In a clean PKI no files exist yet, just the bare directories. Commands called
Expand Down

0 comments on commit a2f5db3

Please sign in to comment.