Skip to content

Commit

Permalink
Reorganize doumentation
Browse files Browse the repository at this point in the history
  • Loading branch information
juga0 committed Apr 9, 2017
1 parent a731475 commit 8468644
Show file tree
Hide file tree
Showing 7 changed files with 54 additions and 24 deletions.
20 changes: 14 additions & 6 deletions docs/source/about.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ State-transition diagram for DHCP clients:
Current status
--------------

WIP, still not recommended for end users.
Minimal version implemented, still to be improved.

See :ref:`todo`

Expand All @@ -72,12 +72,20 @@ See :ref:`install`
Download
--------

You can download this project in either
`zip <http://github.com/juga0/dhcpcanon/zipball/master()>`__
or `tar <http://github.com/juga0/dhcpcanon/tarball/master>`__ formats.
See :ref:`download`

You can also clone the project with Git by running:
git clone git://github.com/juga0/dhcpcanon
Developers documentation
--------------------------

:ref:`api`

:ref:`integration`

:ref:`rfcs`

:ref:`tech`

:ref:`rfc7844comm`

Bugs and features
-----------------
Expand Down
4 changes: 4 additions & 0 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.. _api:

API
=====
11 changes: 11 additions & 0 deletions docs/source/download.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. _download:

Download dhcpcanon
===================

You can download this project in either
`zip <http://github.com/juga0/dhcpcanon/zipball/master()>`__
or `tar <http://github.com/juga0/dhcpcanon/tarball/master>`__ formats.

You can also clone the project with Git by running:
git clone git://github.com/juga0/dhcpcanon
11 changes: 8 additions & 3 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
Install dhcpcanon
=================

Installation in Debian testing
-------------------------------

sudo apt install dhcpcanon

Installation in Debian/Ubuntu from source code
----------------------------------------------

Expand All @@ -11,7 +16,7 @@ Install system dependencies

::

sudo apt-get install python-dev
sudo apt install python-dev

Install dhcpcanon dependencies with virtualenv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -23,7 +28,7 @@ Check https://virtualenv.pypa.io/en/latest/installation.html or
if Debian equal/newer than Jessie (virtualenv version equal or greater
than 1.9), then:

sudo apt-get install python-virtualenv
sudo apt install python-virtualenv

Create a virtual environment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -41,4 +46,4 @@ Install dependencies in virtualenv
or run:
python setup.py install
or run:
pip install dhcpcanon
pip install dhcpcanon
2 changes: 2 additions & 0 deletions docs/source/integration.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _integration:

Integration
=============

Expand Down
26 changes: 12 additions & 14 deletions docs/source/rfcs.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
.. _rfcs:

=============
DHCP RFCs
============
Relevant RFCs
=====================

IETF DHC Working Group
=========================
- `privacy related RFCs repository <https://github.com/juga0/privacy>`__
- DHCP Anonymity Profile `RFC7844 <https://tools.ietf.org/html/rfc7844>`__
- DHCP standard `Dynamic Host Configuration Protocol <https://tools.ietf.org/html/rfc2131>`__
- `Node-specific Client Identifiers for Dynamic Host Configuration Protcol Version Four (DHCPv4) <https://tools.ietf.org/html/rfc4361>`__

`privacy related RFCs repo <https://github.com/juga0/privacy>`__
IETF DHC Working Group maling list
===================================

DHCP Anonymity Profile `RFC7844 <https://tools.ietf.org/html/rfc7844>`__
relevant messages discussing RFC7844:

`Searchable dhcwg maling list <https://mailarchive.ietf.org/arch/search/?email_list=dhcwg`__

`dhcwg maling list anonymity profiles filtered <https://mailarchive.ietf.org/arch/search/?email_list=dhcwg&q=anonymity+profiles+for+dhcp+clients>`__

`dhcwg maling list anonymity profiles filtered mbox <https://mailarchive.ietf.org/arch/export/mbox/?email_list=dhcwg&q=anonymity+profiles+for+dhcp+clients>`__

DHCP standard `Dynamic Host Configuration Protocol <https://tools.ietf.org/html/rfc2131>`__
- `Searchable dhcwg maling list <https://mailarchive.ietf.org/arch/search/?email_list=dhcwg`__
- `dhcwg maling list anonymity profiles filtered <https://mailarchive.ietf.org/arch/search/?email_list=dhcwg&q=anonymity+profiles+for+dhcp+clients>`__
- `dhcwg maling list anonymity profiles filtered mbox <https://mailarchive.ietf.org/arch/export/mbox/?email_list=dhcwg&q=anonymity+profiles+for+dhcp+clients>`__
4 changes: 3 additions & 1 deletion docs/source/tech.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _tech:

RFC7844 implementation considerations
==========================================

Expand All @@ -10,7 +12,7 @@ tools implement already the standard.
This is intended to be an example of the anonymity profiles implementation.

``SHOULD`` options
----------------
--------------------

Leases
-------
Expand Down

0 comments on commit 8468644

Please sign in to comment.