Skip to content

Commit

Permalink
docs: update markdown to Hove
Browse files Browse the repository at this point in the history
  • Loading branch information
woshilapin committed Apr 7, 2022
1 parent 7afc9e8 commit f8f035a
Show file tree
Hide file tree
Showing 19 changed files with 2,581 additions and 2,581 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

## Overview on how-to contribute

Dev branch: [![Last build](https://img.shields.io/github/workflow/status/CanalTP/navitia/Build%20Navitia%20Packages%20For%20Dev?logo=github&style=flat-square)](https://github.com/CanalTP/navitia/actions?query=workflow%3A%22Build+Navitia+Packages+For+Dev%22)
Dev branch: [![Last build](https://img.shields.io/github/workflow/status/hove-io/navitia/Build%20Navitia%20Packages%20For%20Dev?logo=github&style=flat-square)](https://github.com/hove-io/navitia/actions?query=workflow%3A%22Build+Navitia+Packages+For+Dev%22)

Fork the github repo, create a new branch from dev, and submit your pull request!

Expand All @@ -19,13 +19,13 @@ If you have the rights, once your PR has 2 approvals, you are encouraged to merg
## Build Navitia

If you want to build navitia, please refer to the
[installation documentation](https://github.com/canaltp/navitia/blob/dev/install.rst).
[installation documentation](https://github.com/hove-io/navitia/blob/dev/install.rst).

You can install a full development environment with helping
[scripts](https://github.com/CanalTP/navitia/tree/dev/scripts), depending on your OS.
[scripts](https://github.com/hove-io/navitia/tree/dev/scripts), depending on your OS.

Therefore, an
[automated navitia script](https://github.com/canaltp/navitia/blob/dev/scripts/build_setup_and_run_navitia_demo.sh)
[automated navitia script](https://github.com/hove-io/navitia/blob/dev/scripts/build_setup_and_run_navitia_demo.sh)
is available to build, setup and run a navitia demo.
It's needed as a prerequisite for a dev environment setup.
Kraken is built into navitia_dir/build_release and all demo files are available in navitia_dir/run:
Expand All @@ -46,7 +46,7 @@ At the root of the repository, several directories can be found:

1. source: contains the navitia source code (c++ and python)
2. documentation: all the navitia documentation
3. release: contains [script_release.py](https://github.com/canaltp/navitia/blob/dev/release/script_release.py) to run the release process
3. release: contains [script_release.py](https://github.com/hove-io/navitia/blob/dev/release/script_release.py) to run the release process
4. scripts: different useful scripts

### `data_version` management
Expand Down
5,046 changes: 2,523 additions & 2,523 deletions debian/changelog

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion documentation/ntfs/readme.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
NTFS specifications have been moved to their own repository: https://github.com/CanalTP/ntfs-specification
NTFS specifications have been moved to their own repository: https://github.com/hove-io/ntfs-specification
2 changes: 1 addition & 1 deletion documentation/rfc/sorting_vehicles_route_schedules.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Thus, in our case, this algorithm seems to run in

which is much better than the naive implementation. In practice, our problematic case run in 33 seconds using the naive algorithm, and 1 seconds using the binary searches.

For the details and the implementation, you can see [navitia's pull request #1366](https://github.com/CanalTP/navitia/pull/1366).
For the details and the implementation, you can see [navitia's pull request #1366](https://github.com/hove-io/navitia/pull/1366).

# Stop points' revolution

Expand Down
14 changes: 7 additions & 7 deletions documentation/slate/source/includes/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Technically, Navitia is a [HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) API t

### Who's who

Navitia is instanciated and exposed publicly through [api.navitia.io](https://api.navitia.io).<br>Developments on Navitia are lead by Hove (previously CanalTP).<br>Hove is a subsidiary of Keolis (itself a subsidiary of SNCF, French national railway company).
Navitia is instanciated and exposed publicly through [api.navitia.io](https://api.navitia.io).<br>Developments on Navitia are lead by Hove (previously Kisio Digital and CanalTP).<br>Hove is a subsidiary of Keolis (itself a subsidiary of SNCF, French national railway company).

### About "sandbox" coverage

Expand Down Expand Up @@ -93,20 +93,20 @@ At some point you will want to read [transport public lexicon](#lexicon).
Navitia for humans
------------------

>[Try a basic request on Navitia playground](https://canaltp.github.io/navitia-playground/play.html?request=https%3A%2F%2Fapi.navitia.io%2Fv1%2Fcoverage%2Fsandbox&token=3b036afe-0110-4202-b9ed-99718476c2e0)
>[Try a basic request on Navitia playground](https://playground.navitia.io/play.html?request=https%3A%2F%2Fapi.navitia.io%2Fv1%2Fcoverage%2Fsandbox&token=3b036afe-0110-4202-b9ed-99718476c2e0)
>[Try a journey request on Navitia playground](https://canaltp.github.io/navitia-playground/play.html?request=https%3A%2F%2Fapi.navitia.io%2Fv1%2Fcoverage%2Fsandbox%2Fjourneys%3Ffrom%3D2.3749036%253B48.8467927%26to%3D2.2922926%253B48.8583736%26&token=3b036afe-0110-4202-b9ed-99718476c2e0)
>[Try a journey request on Navitia playground](https://playground.navitia.io/play.html?request=https%3A%2F%2Fapi.navitia.io%2Fv1%2Fcoverage%2Fsandbox%2Fjourneys%3Ffrom%3D2.3749036%253B48.8467927%26to%3D2.2922926%253B48.8583736%26&token=3b036afe-0110-4202-b9ed-99718476c2e0)
<aside class="success">
if you only want to challenge Navitia functionality, take your token and go to the <a href="https://canaltp.github.io/navitia-playground">navitia playground website </a>.
if you only want to challenge Navitia functionality, take your token and go to the <a href="https://playground.navitia.io">navitia playground website </a>.
</aside>

![Try Navitia playgroung](/images/navitia_playground.png)

Wrappers
--------------

To help you in the building of your project, there are some wrappers implemented (by Kisio or not) to query the API Navitia:
To help you in the building of your project, there are some wrappers implemented (by Hove or not) to query the API Navitia:

|Language / Framework |Plugin |
|---------------------|----------------------------------------------------|
Expand All @@ -117,7 +117,7 @@ To help you in the building of your project, there are some wrappers implemented

<h2 id="about-data">About the data</h2>

The street network is extracted from [OpenStreetMap](https://www.openstreetmap.org). The public transport data are provided by networks that provide their timetables as open data. Some data improvements are achieved by Kisio Digital and are published back there <https://navitia.opendatasoft.com>.
The street network is extracted from [OpenStreetMap](https://www.openstreetmap.org). The public transport data are provided by networks that provide their timetables as open data. Some data improvements are achieved by Hove and are published back there <https://navitia.opendatasoft.com>.

Want to know if your city is in Navitia? Know if a special contributor is used? You can either search in [datasets](#datasets) of the different [coverages](#coverage). Or use the filter provided on our data catalog <https://navitia.opendatasoft.com>.

Expand Down Expand Up @@ -145,7 +145,7 @@ If you want to go further, there is an Swagger-openAPI documentation at [https:/
A mailing list is available to ask questions or request [new data](#about-data) integrations: <a href="mailto:[email protected]">[email protected]</a>

In order to report bug and make feature requests please use our github navitia project
<https://github.com/CanalTP/navitia/issues>.
<https://github.com/hove-io/navitia/issues>.

Stay tuned on twitter [@navitia](https://twitter.com/navitia).

Expand Down
4 changes: 2 additions & 2 deletions documentation/slate/source/layouts/layout.erb
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ under the License.
<!doctype html>
<html>
<head>
<!-- favicon added by Kisio Digital -->
<!-- favicon added by Hove -->
<%= favicon_tag 'favicon.ico' %>
<!-- end of section added by Kisio Digital -->
<!-- end of section added by Hove -->
<meta charset="utf-8">
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
Expand Down
2 changes: 1 addition & 1 deletion documentation/slate/source/stylesheets/screen.css.scss
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ html, body {
margin-bottom: 0.8em;
}

// font-size modified by Kisio Digital (10 -> 14)
// font-size modified by Hove (10 -> 14)
h4, h5, h6 {
font-size: 14px;
}
Expand Down
16 changes: 8 additions & 8 deletions documentation/vagrant/vagrant.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Clone source files (use ssh instead of http if you have a github account, no git
cd dev/navitia_dev
mkdir source build
cd source
git clone https://github.com/CanalTP/navitia.git
git clone https://github.com/hove-io/navitia.git
```

If you don't use a github account, before submodule init:
Expand All @@ -92,15 +92,15 @@ Below is what it should look like:
```
[submodule "source/utils"]
path = source/utils
url = https://github.com/CanalTP/utils.git
url = https://github.com/hove-io/utils.git
[submodule "source/third_party/osmpbfreader"]
path = source/third_party/osmpbfreader
url = https://github.com/CanalTP/libosmpbfreader.git
url = https://github.com/hove-io/libosmpbfreader.git
[submodule "source/third_party/SimpleAmqpClient"]
path = source/third_party/SimpleAmqpClient
url = https://github.com/CanalTP/SimpleAmqpClient.git
url = https://github.com/hove-io/SimpleAmqpClient.git
[submodule "source/third_party/librabbitmq-c"]
path = source/third_party/librabbitmq-c
Expand All @@ -112,11 +112,11 @@ url = https://github.com/antirez/linenoise.git
[submodule "source/chaos-proto"]
path = source/chaos-proto
url = https://github.com/CanalTP/chaos-proto.git
url = https://github.com/hove-io/chaos-proto.git
[submodule "source/navitia-proto"]
path = source/navitia-proto
url = https://github.com/CanalTP/navitia-proto.git
url = https://github.com/hove-io/navitia-proto.git
```

Update submodules:
Expand Down Expand Up @@ -341,10 +341,10 @@ JORMUNGANDR_CONFIG_FILE="/navitia_dev/run/jormungandr_settings.py" PYTHONPATH="/
Navitia API is now running at localhost:5001!


Setting up Chaos (see docs in Github): [https://github.com/CanalTP/Chaos](https://github.com/CanalTP/Chaos)
Setting up Chaos (see docs in Github): [https://github.com/hove-io/Chaos](https://github.com/hove-io/Chaos)
```sh
cd /navitia_dev/source
git clone https://github.com/CanalTP/Chaos.git
git clone https://github.com/hove-io/Chaos.git

cd Chaos
mkvirtualenv chaos
Expand Down
4 changes: 2 additions & 2 deletions install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Testing

This step will generate a compressed nav file that can be given as input to *Kraken*

***Alternative to step 1 to 5*** : You can use *Eitri* as an alternative to generate the *.nav* file (cf. https://github.com/CanalTP/navitia/tree/dev/source/eitri). This will setup the environment and call the right tool for you. Hasle-free Navitia file generator :)
***Alternative to step 1 to 5*** : You can use *Eitri* as an alternative to generate the *.nav* file (cf. https://github.com/hove-io/navitia/tree/dev/source/eitri). This will setup the environment and call the right tool for you. Hasle-free Navitia file generator :)

#. Running the *Kraken* backend

Expand All @@ -153,4 +153,4 @@ Testing

#. Grab a browser and open http://localhost:5000/v1/coverage/default_region

#. Any trouble running Jormungandr see https://github.com/CanalTP/navitia/blob/dev/source/jormungandr/readme.md
#. Any trouble running Jormungandr see https://github.com/hove-io/navitia/blob/dev/source/jormungandr/readme.md
22 changes: 11 additions & 11 deletions readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@
:target: https://app.element.io/#/room/#navitia:matrix.org
:alt: chat

.. |Code Coverage| image:: https://sonarcloud.io/api/project_badges/measure?project=CanalTP_navitia&metric=coverage
.. |Code Coverage| image:: https://sonarcloud.io/api/project_badges/measure?project=Hove_navitia&metric=coverage
:alt: SonarCloud Coverage

.. |Vulnerabilities| image:: https://sonarcloud.io/api/project_badges/measure?project=CanalTP_navitia&metric=vulnerabilities
.. |Vulnerabilities| image:: https://sonarcloud.io/api/project_badges/measure?project=Hove_navitia&metric=vulnerabilities
:alt: SonarCloud Vulnerabilities

.. |Security Rating| image:: https://sonarcloud.io/api/project_badges/measure?project=CanalTP_navitia&metric=security_rating
.. |Security Rating| image:: https://sonarcloud.io/api/project_badges/measure?project=Hove_navitia&metric=security_rating
:alt: SonarCloud Security Rating


Expand All @@ -42,22 +42,22 @@
+----------------+----------------+-----------+--------+-----------------+-------------------+-------------------+


.. |Maintainability Rating| image:: https://sonarcloud.io/api/project_badges/measure?project=CanalTP_navitia&metric=sqale_rating
.. |Maintainability Rating| image:: https://sonarcloud.io/api/project_badges/measure?project=Hove_navitia&metric=sqale_rating
:alt: SonarCloud Maintainability Rating

.. |Quality Gate Status| image:: https://sonarcloud.io/api/project_badges/measure?project=CanalTP_navitia&metric=alert_status
.. |Quality Gate Status| image:: https://sonarcloud.io/api/project_badges/measure?project=Hove_navitia&metric=alert_status
:alt: SonarCloud Quality Gate Status

.. |Duplicated Lines (%)| image:: https://sonarcloud.io/api/project_badges/measure?project=CanalTP_navitia&metric=duplicated_lines_density
.. |Duplicated Lines (%)| image:: https://sonarcloud.io/api/project_badges/measure?project=Hove_navitia&metric=duplicated_lines_density
:alt: SonarCloud Duplicated Lines (%)

.. |Reliability Rating| image:: https://sonarcloud.io/api/project_badges/measure?project=CanalTP_navitia&metric=reliability_rating
.. |Reliability Rating| image:: https://sonarcloud.io/api/project_badges/measure?project=Hove_navitia&metric=reliability_rating
:alt: SonarCloud Reliability Rating

.. |Bugs| image:: https://sonarcloud.io/api/project_badges/measure?project=CanalTP_navitia&metric=bugs
.. |Bugs| image:: https://sonarcloud.io/api/project_badges/measure?project=Hove_navitia&metric=bugs
:alt: SonarCloud Bugs

.. |Lines of Code| image:: https://sonarcloud.io/api/project_badges/measure?project=CanalTP_navitia&metric=ncloc
.. |Lines of Code| image:: https://sonarcloud.io/api/project_badges/measure?project=Hove_navitia&metric=ncloc
:alt: SonarCloud Lines of Code

+--------------------------+-----------------------+------------------------+----------------------+--------+-------------------+
Expand Down Expand Up @@ -106,8 +106,8 @@ Who's who
----------

| Navitia is instanciated and exposed publicly through api.navitia.io_.
| Developments on Navitia are lead by Kisio Digital (previously CanalTP).
| Kisio Digital is a subsidiary of Keolis (itself a subsidiary of SNCF, French national railway company).
| Developments on Navitia are lead by Hove (previously Kisio Digital and CanalTP).
| Hove is a subsidiary of Keolis (itself a subsidiary of SNCF, French national railway company).
.. _api.navitia.io: https://api.navitia.io

Expand Down
4 changes: 2 additions & 2 deletions readme_release.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This lets the script decide if it's major or minor release.
The decision is based on the data_version located in source/type/data.cpp
See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how data_version is managed.

First have a look on github's repo at PRs about to be released https://github.com/CanalTP/navitia/pulls?q=is%3Apr+is%3Aclosed+sort%3Aupdated-desc
First have a look on github's repo at PRs about to be released https://github.com/hove-io/navitia/pulls?q=is%3Apr+is%3Aclosed+sort%3Aupdated-desc
* Check that `not_in_changelog` and `hotfix` labels are correct and none is missing on PRs that are gonna be released
* Check that titles are correct (clear, with the component impacted)

Expand Down Expand Up @@ -63,7 +63,7 @@ Then the process is less automated (but still, instructions are given):
```
Version 2.57.0

* Kraken: Add ptref shortcut between physical_mode and jpps <https://github.com/CanalTP/navitia/pull/2417>
* Kraken: Add ptref shortcut between physical_mode and jpps <https://github.com/hove-io/navitia/pull/2417>
```

## And Finally
Expand Down
4 changes: 2 additions & 2 deletions source/ed/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,13 @@ Component that loads a GTFS data set into `ed`.

The directory containing all gtfs text files is given with the `-i` option

Warning: This component will soon be deprecated and replaced by our gtfs2ntfs converter.<br>You can check it in [navitia_model](https://github.com/CanalTP/navitia_model).
Warning: This component will soon be deprecated and replaced by our gtfs2ntfs converter.<br>You can check it in [navitia_model](https://github.com/hove-io/navitia_model).
The output NTFS will then be provided to fusio2ed.

## fusio2ed
Component that loads a NTFS fusio data set into `ed`.

NTFS is a CanalTP custom file format derived from GTFS but with additional files.
NTFS is a Hove custom file format derived from GTFS but with additional files.

The directory containing all NTFS text files is given with the `-i` option

Expand Down
10 changes: 5 additions & 5 deletions source/jormungandr/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ Create a file `jormungandr.json` in a custom directory like:
}
```

You can copy the one from [documentation/examples/config/Jormungandr.json](https://github.com/CanalTP/navitia/blob/dev/documentation/examples/config/Jormungandr.json)
You can copy the one from [documentation/examples/config/Jormungandr.json](https://github.com/hove-io/navitia/blob/dev/documentation/examples/config/Jormungandr.json)

Make sure `key` and `socket` respectively match `instance_name` and `zmq_socket` from your Kraken config file ([kraken.ini](https://github.com/CanalTP/navitia/blob/dev/documentation/examples/config/kraken.ini)).
Make sure `key` and `socket` respectively match `instance_name` and `zmq_socket` from your Kraken config file ([kraken.ini](https://github.com/hove-io/navitia/blob/dev/documentation/examples/config/kraken.ini)).

As an alternative, you can also give the json through an environment variable like:
```sh
Expand All @@ -45,7 +45,7 @@ JORMUNGANDR_INSTANCE_FR_IDF='{"key": "fr-idf","zmq_socket": "tcp://localhost:300

## Environment Variables

Environment variables can be set when the service is started. Referer to [default_settings.py](https://github.com/CanalTP/navitia/blob/dev/source/jormungandr/jormungandr/default_settings.py)
Environment variables can be set when the service is started. Referer to [default_settings.py](https://github.com/hove-io/navitia/blob/dev/source/jormungandr/jormungandr/default_settings.py)

example for a development environment:

Expand Down Expand Up @@ -142,8 +142,8 @@ Jormungandr is trying to access a "jormungandr" database. You can disable this d

The profiling of Jormungandr is done thanks to Werkzeug profiler, for more details, one can read this interesting [article](https://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-xvi-debugging-testing-and-profiling), more specifically, in the Profiling section.

To enable the profiling of Jormungandr, one must set `ACTIVATE_PROFILING` to True in the `$JORMUNGANDR_CONFIG_FILE`[default_settings.py](https://github.com/CanalTP/navitia/blob/dev/source/jormungandr/jormungandr/default_settings.py).
Then set the correct directory(create one if not exists) for the output of profiler [profile](https://github.com/CanalTP/navitia/blob/dev/source/jormungandr/jormungandr/api.py#L130).
To enable the profiling of Jormungandr, one must set `ACTIVATE_PROFILING` to True in the `$JORMUNGANDR_CONFIG_FILE`[default_settings.py](https://github.com/hove-io/navitia/blob/dev/source/jormungandr/jormungandr/default_settings.py).
Then set the correct directory(create one if not exists) for the output of profiler [profile](https://github.com/hove-io/navitia/blob/dev/source/jormungandr/jormungandr/api.py#L130).

The profiling is triggered on every arrival of a request, so a profile file is generated when a request is processed.

Expand Down
Loading

0 comments on commit f8f035a

Please sign in to comment.