Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove docs #3

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 2 additions & 39 deletions docs/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,43 +17,6 @@ specific language governing permissions and limitations
under the License
////

= Qpid Dispatch Router documentation
= Skupper Router documentation

This directory contains the documentation for Qpid Dispatch Router. The documentation consists of a user guide, man pages, and a configuration reference.

[source,bash,options="nowrap",subs="+quotes"]
----
/docs
├── books # Files for the Dispatch Router user guide.
├── man # Man page source files and scripts.
└── notes # Developer notes: project information, design notes, or anything else that's primarily of developer interest; these are not installed.
----

== Contributing to the documentation

Apache Qpid welcomes contributions from the community. To contribute to the documentation, see the link:notes/contrib-guide.adoc[Contributor's Guide].

To file a documentation bug or tell us about any other issue with the documentation, visit the link:https://issues.apache.org/jira/projects/DISPATCH[Apache Dispatch JIRA project]. When creating the issue, be sure to select the `Documentation` component, and be as specific as possible about the changes you would like to see.

[id='building-documentation']
== Building the documentation

You must have the following tools to build the documentation:

* link:https://github.com/asciidoctor/asciidoctor[`asciidoctor` (1.5.6)] for building books
* link:http://asciidoc.org/INSTALL.html[`asciidoc` (8.6.8)] for building man pages

Clone the qpid-dispatch repository:

[source,bash,options="nowrap",subs="+quotes"]
----
$ git clone https://github.com/apache/qpid-dispatch.git
$ cd qpid-dispatch
----

Build the documentation:

[source,bash,options="nowrap",subs="+quotes"]
----
$ make docs
----
While there is no documentation for Skupper Router yet, you can view the https://github.com/apache/qpid-dispatch/tree/main/docs[qpid dispatch] documentation.
54 changes: 0 additions & 54 deletions docs/books/CMakeLists.txt

This file was deleted.

44 changes: 0 additions & 44 deletions docs/books/assemblies/user-guide/configuring-authorization.adoc

This file was deleted.

This file was deleted.

33 changes: 0 additions & 33 deletions docs/books/assemblies/user-guide/configuring-logging.adoc

This file was deleted.

50 changes: 0 additions & 50 deletions docs/books/assemblies/user-guide/configuring-message-routing.adoc

This file was deleted.

This file was deleted.

50 changes: 0 additions & 50 deletions docs/books/assemblies/user-guide/configuring-router.adoc

This file was deleted.

Loading