Skip to content

Commit 64449cc

Browse files
vishalvvrvishalvvr
authored
Restructure Readthedocs documentation (#3428)
* Restructure Readthedocs documentation Pbench docs (Readthedocs) need some rework, so this is the first step towards documentation efforts. This is just a structural change, this commit does not intend to make content level changes. Changes: - New directory structure. - Copy existing Contributing, Server API doc, getting started, user guide and system design files to new dir - Add support for markdown files(earlier it was only reStructuredText).
1 parent 49ffc55 commit 64449cc

35 files changed

+84
-8
lines changed

‎docs/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_build/

‎docs/Agent/faq.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# FAQ

‎docs/Agent/installation/Ansible_based_installation.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Ansible based installation

‎docs/Agent/installation/index.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Installation
2+
=========================
3+
4+
Choose any one of the following approaches to setup `Pbench Agent`
5+
6+
.. toctree::
7+
:maxdepth: 2
8+
9+
pbench-containers
10+
rpm_based_installation
11+
Ansible_based_installation
12+

‎docs/Agent/installation/pbench-containers.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Pbench containers
2+

‎docs/Agent/installation/rpm_based_installation.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# RPM based installation

‎docs/guides/UserGuide.rst‎ renamed to ‎docs/Agent/user-guide/UserGuide.rst‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ User Guide
44
##############
55

66
.. contents::
7-
87
What is Pbench?
98
****************
109

‎docs/GETTING_STARTED.md‎ renamed to ‎docs/Agent/user-guide/getting_started.md‎

File renamed without changes.

‎docs/Agent/user-guide/index.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
User Guide
2+
==========
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
getting_started
8+
UserGuide
9+
man_page

‎docs/Agent/user-guide/man_page.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Man Page

0 commit comments

Comments
 (0)