Rename Quick Start Guide
I don't think our quick start guide is so quick anymore. I thinka more accurate name is "User Guide". This CR renames the quick start guide. Change-Id: I7c6f264864d65441e21cbc7fc7a9b0532a8ebae1
This commit is contained in:
parent
ebd096a9a3
commit
c1b324f4b6
@ -2,19 +2,19 @@
|
|||||||
Barbican API Documentation
|
Barbican API Documentation
|
||||||
**************************
|
**************************
|
||||||
|
|
||||||
Quick Start
|
User Guide
|
||||||
###########
|
###########
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
./quickstart/secrets
|
./userguide/secrets
|
||||||
./quickstart/containers
|
./userguide/containers
|
||||||
./quickstart/acls
|
./userguide/acls
|
||||||
./quickstart/pkcs11keygeneration
|
./userguide/pkcs11keygeneration
|
||||||
./quickstart/certificates
|
./userguide/certificates
|
||||||
./quickstart/dogtag_setup
|
./userguide/dogtag_setup
|
||||||
./quickstart/quotas
|
./userguide/quotas
|
||||||
|
|
||||||
API Reference
|
API Reference
|
||||||
#############
|
#############
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
*************************
|
*************************
|
||||||
ACL API - Quick Start
|
ACL API - User Guide
|
||||||
*************************
|
*************************
|
||||||
|
|
||||||
By default Barbican manages access to its resources (secrets, containers) on a per project
|
By default Barbican manages access to its resources (secrets, containers) on a per project
|
@ -1,5 +1,5 @@
|
|||||||
*****************************************
|
*****************************************
|
||||||
Certificate Authorities API - Quick Start
|
Certificate Authorities API - User Guide
|
||||||
*****************************************
|
*****************************************
|
||||||
|
|
||||||
Barbican is used as an interface to interact with Certificate Authorities (both
|
Barbican is used as an interface to interact with Certificate Authorities (both
|
@ -1,5 +1,5 @@
|
|||||||
******************************
|
******************************
|
||||||
Certificates API - Quick Start
|
Certificates API - User Guide
|
||||||
******************************
|
******************************
|
||||||
|
|
||||||
Barbican will be used to manage the lifecycle of x509 certificates covering
|
Barbican will be used to manage the lifecycle of x509 certificates covering
|
@ -1,5 +1,5 @@
|
|||||||
****************************
|
****************************
|
||||||
Containers API - Quick Start
|
Containers API - User Guide
|
||||||
****************************
|
****************************
|
||||||
|
|
||||||
The containers resource is the organizational center piece of Barbican. It
|
The containers resource is the organizational center piece of Barbican. It
|
||||||
@ -153,7 +153,7 @@ How to Create a Container
|
|||||||
|
|
||||||
In order to create a container, we must first have secrets. If you are unfamiliar
|
In order to create a container, we must first have secrets. If you are unfamiliar
|
||||||
with creating secrets, please take some time to refer to the
|
with creating secrets, please take some time to refer to the
|
||||||
:doc:`Secret Quickstart Guide <secrets>` before moving forward.
|
:doc:`Secret User Guide <secrets>` before moving forward.
|
||||||
|
|
||||||
.. _create_generic_container:
|
.. _create_generic_container:
|
||||||
|
|
@ -1,5 +1,5 @@
|
|||||||
**************************
|
**************************
|
||||||
Dogtag Setup - Quick Start
|
Dogtag Setup - User Guide
|
||||||
**************************
|
**************************
|
||||||
|
|
||||||
Dogtag is the Open Source upstream community version of the Red Hat Certificate
|
Dogtag is the Open Source upstream community version of the Red Hat Certificate
|
@ -1,5 +1,5 @@
|
|||||||
***********************************
|
***********************************
|
||||||
PKCS11 Key Generation - Quick Start
|
PKCS11 Key Generation - User Guide
|
||||||
***********************************
|
***********************************
|
||||||
|
|
||||||
The Key Generation script was written with the Deployer in mind. It allows the
|
The Key Generation script was written with the Deployer in mind. It allows the
|
@ -1,5 +1,5 @@
|
|||||||
************************
|
************************
|
||||||
Quotas API - Quick Start
|
Quotas API - User Guide
|
||||||
************************
|
************************
|
||||||
|
|
||||||
Running with default settings, the Barbican REST API doesn't impose an upper
|
Running with default settings, the Barbican REST API doesn't impose an upper
|
||||||
@ -11,14 +11,14 @@ can exhaust available resources, impacting other projects.
|
|||||||
|
|
||||||
The answer to this, on a per-project basis, is project quotas.
|
The answer to this, on a per-project basis, is project quotas.
|
||||||
|
|
||||||
This quick start guide will show you how a user can lookup his current effective
|
This user guide will show you how a user can lookup his current effective
|
||||||
quotas and how a service admin can create, update, read, and delete project quota
|
quotas and how a service admin can create, update, read, and delete project quota
|
||||||
configuration for all projects in his cloud.
|
configuration for all projects in his cloud.
|
||||||
|
|
||||||
This guide will assume you will be using a local running development environment of Barbican.
|
This guide will assume you will be using a local running development environment of Barbican.
|
||||||
If you need assistance with getting set up, please reference the :doc:`development guide </setup/dev>`.
|
If you need assistance with getting set up, please reference the :doc:`development guide </setup/dev>`.
|
||||||
|
|
||||||
.. _quick_project_quotas_overview:
|
.. _user_project_quotas_overview:
|
||||||
|
|
||||||
Project Quotas Overview
|
Project Quotas Overview
|
||||||
#######################
|
#######################
|
||||||
@ -68,7 +68,7 @@ The default quotas are returned via a **GET** on the **quotas** resource when no
|
|||||||
explicit project quotas have been set for the current project.
|
explicit project quotas have been set for the current project.
|
||||||
|
|
||||||
|
|
||||||
.. _quick_get_quotas:
|
.. _user_get_quotas:
|
||||||
|
|
||||||
How to Read Effective Quotas
|
How to Read Effective Quotas
|
||||||
############################
|
############################
|
||||||
@ -104,7 +104,7 @@ To get more details on the quota lookup API, you can reference the
|
|||||||
:ref:`Get Quotas <get_quotas_request>` documentation.
|
:ref:`Get Quotas <get_quotas_request>` documentation.
|
||||||
|
|
||||||
|
|
||||||
.. _quick_put_project_quotas:
|
.. _user_put_project_quotas:
|
||||||
|
|
||||||
How to Set or Replace Project Quotas
|
How to Set or Replace Project Quotas
|
||||||
####################################
|
####################################
|
||||||
@ -135,7 +135,7 @@ To get more details on the project quota setting API you can reference
|
|||||||
the :ref:`Set Project Quotas <put_project_quotas>` documentation.
|
the :ref:`Set Project Quotas <put_project_quotas>` documentation.
|
||||||
|
|
||||||
|
|
||||||
.. _quick_get_project_quotas:
|
.. _user_get_project_quotas:
|
||||||
|
|
||||||
How to Retrieve Configured Project Quotas
|
How to Retrieve Configured Project Quotas
|
||||||
#########################################
|
#########################################
|
||||||
@ -206,7 +206,7 @@ the :ref:`Get Project Quota <get_project_quotas_uuid>` and
|
|||||||
:ref:`Get Project Quota List <get_project_quotas>` documentation.
|
:ref:`Get Project Quota List <get_project_quotas>` documentation.
|
||||||
|
|
||||||
|
|
||||||
.. _quick_delete_project_quotas:
|
.. _user_delete_project_quotas:
|
||||||
|
|
||||||
How to Delete Configured Project Quotas
|
How to Delete Configured Project Quotas
|
||||||
#######################################
|
#######################################
|
@ -1,5 +1,5 @@
|
|||||||
*************************
|
*************************
|
||||||
Secrets API - Quick Start
|
Secrets API - User Guide
|
||||||
*************************
|
*************************
|
||||||
|
|
||||||
The secrets resource is the heart of the Barbican service. It provides access
|
The secrets resource is the heart of the Barbican service. It provides access
|
||||||
@ -24,7 +24,7 @@ Some examples of a secret may include:
|
|||||||
* Password
|
* Password
|
||||||
* SSH Keys
|
* SSH Keys
|
||||||
|
|
||||||
For the purpose of this quickstart guide, we will use a simple plaintext
|
For the purpose of this user guide, we will use a simple plaintext
|
||||||
secret. If you would like to learn more in detail about :ref:`secret parameters <secret_parameters>`,
|
secret. If you would like to learn more in detail about :ref:`secret parameters <secret_parameters>`,
|
||||||
:ref:`responses <secret_response_attributes>`, and :ref:`status codes <secret_status_codes>`
|
:ref:`responses <secret_response_attributes>`, and :ref:`status codes <secret_status_codes>`
|
||||||
you can reference the :doc:`secret reference <../reference/secrets>`
|
you can reference the :doc:`secret reference <../reference/secrets>`
|
Loading…
x
Reference in New Issue
Block a user