Skip to content

Commit

Permalink
dod doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Patent2net committed Jan 6, 2021
1 parent 5064de5 commit 9ad1b51
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 18 deletions.
6 changes: 3 additions & 3 deletions doc/core/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _devmod:

#################
Core informations
#################
##################################
Global architecture and data model
##################################

.. toctree::
:maxdepth: 1
Expand Down
7 changes: 0 additions & 7 deletions doc/historic/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,6 @@ Historical features
Developper's mode
*****************

..
contents::
:local:
:depth: 2
----

============
installation
============
Expand Down
13 changes: 5 additions & 8 deletions doc/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,25 @@ This part of the documentation covers the installation of Patent2Net.
The first step to using any software package is getting it properly installed.
Please read this section carefully.

After successfully installing the software, you might want to
follow up with its :ref:`configuration`.


============
Installation
============
#. Install docker desktop
#. download the docker-install branch (https://github.com/Patent2net/P2N-v3/tree/docker_install)
#. Use the Install_P2N.bat and enjoy P2N via docker image
#. download the docker-install repository (https://github.com/Patent2net/P2N-Docker)
#. Use the Install_P2N.bat and enjoy Patent2Net via docker image
#. See Install.bat in the elatickibana directory for the full architecture (BETA) with elastic search and Kibana
#. Refer to :ref:`docker-install` procedure for details
#. Refer to :ref:`docker-install` procedures for details

=============
Configuration
=============
- setup your API key in the `get_started page: <http://localhost:5000/get_started)>`_
- setup your EPO's API key in the `get_started page: <http://localhost:5000/get_started)>`_
- enjoy the request form (http://localhost:5000/form) to make your requests and see progress (Help need to fix UX and SSE consolidate)
- explore results: http://localhost:5000/index
- please help in user design interface!
- go to the :ref:`docker-config` section for details on the interface
- see :ref:`usage` for details.

.. hint: the following on this page concerns developpers and avanced users information. Welcome to new users that should follow first theses pages :ref:`docker-install`, :ref:`usage`.
.. include:: ./historic/install.rst

0 comments on commit 9ad1b51

Please sign in to comment.