Skip to content

Commit

Permalink
reduce instructions to what is useful for the 2.10 branch
Browse files Browse the repository at this point in the history
  • Loading branch information
jodygarnett committed May 24, 2024
1 parent 0a2ac0e commit 9caa454
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 18 deletions.
47 changes: 29 additions & 18 deletions docs/manual/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,34 @@
# Geonetwork Manual and Help
# GeoNetwork Manual and Help

Documentation for GeoNetwork opensource is available via https://geonetwork-opensource.org.
Documentation for GeoNetwork opensource is available via https://docs.geonetwork-opensource.org.

This documentation is written under the creative commons license [Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)](LICENSE.md).
This documentation is written under the Creative Commons license [Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)](LICENSE).

Reference:

* [Documentation Writing Guide](docs/devel/docs/docs.md)
* [Documentation Writing Guide](docs/devel/docs/index.md)

## Communication

The [project issue tracker](https://github.com/geonetwork/core-geonetwork/issues) is used for communication, with ongoing topics tagged [documentation](https://github.com/geonetwork/core-geonetwork/issues?q=is%3Aissue+label%3Adocumenation).

## Material for MkDocs

Documentation is [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) which is a Markdown documentation framework written on top of [MkDocs](https://www.mkdocs.org/).
Documentation is [MkDocs-material](https://squidfunk.github.io/mkdocs-material/) which is a Markdown documentation framework written on top of [MkDocs](https://www.mkdocs.org/).

If you are using python3:
If you are using Python3:

1. Install using ``pip3`` and build:

```bash
pip3 install -r requirements.txt
```

In the future you can update using:

```bash
pip3 install -r requirements.txt -U
```

2. Use ***mkdocs** to preview locally:

Expand All @@ -45,7 +51,7 @@ If you are using python3:

### VirtualEnv

If you use a python virtual environment:
If you use a Python virtual environment:

1. Activate virtual environment:

Expand All @@ -55,6 +61,13 @@ If you use a python virtual environment:
pip install -r requirements.txt
```

In the future you can update with:

```bash
source venv/bin/activate
pip3 install -r requirements.txt
```

2. Use ***mkdocs*** to preview from virtual environment:

```bash
Expand All @@ -63,26 +76,24 @@ If you use a python virtual environment:

3. Preview: http://localhost:8000

### Docker

If you are not familiar with python the mkdocs-material website has instructions for docker:

1. Run mkdocs in Docker environment:

Preview uses a single version, so expect some warnings from version chooser:
```
docker pull squidfunk/mkdocs-material
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
"GET /versions.json HTTP/1.1" code 404
```

4. Optional: Preview online help:

2. Preview: http://localhost:8000

```bash
mkdocs serve --config-file help.yml
```

## Publish 2.10.x Archive Docs

We use ``mike`` for publishing (from the `gh-pages` branch). Docs are published by the ``.github/workflows/docs.yml`` automation each time pull-request is merged.

If you wish to preview using your own `gh-pages` branch:

1. To update publish documentation:
1. To update publish 2.10 documentation:

```bash
mike deploy --push 2.10
Expand Down
6 changes: 6 additions & 0 deletions docs/manual/overrides/partials/main.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{% extends "base.html" %}

{% block outdated %}
GeoNetwork 2.10 is outdated.
<a href="{{ '../' ~ base_url }}"><strong>Click here to go to stable.</strong></a>
{% endblock %}

0 comments on commit 9caa454

Please sign in to comment.