Skip to content

Commit

Permalink
how to update mkdoc env (removed instructions for docker mkdocs use) (g…
Browse files Browse the repository at this point in the history
…eonetwork#8089)

* how to update mkdoc env (removed instructions for docker mkdocs use)
* maintenance release description, fix broken link on change-log/history for stable and maintenance headings
* added outdated banner for when 4.4.x eventually is unsupported
* fix documentation warnings
  • Loading branch information
jodygarnett authored and fxprunayre committed Jul 18, 2024
1 parent 208a130 commit cbeabf5
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 15 deletions.
31 changes: 21 additions & 10 deletions docs/manual/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ If you are using Python3:
```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 Down Expand Up @@ -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,18 +76,16 @@ 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
```

## Maven Integration

Expand Down Expand Up @@ -108,7 +119,7 @@ If you wish to preview using your own `gh-pages` branch:
mike deploy --title "4.4 Latest" --alias-type=copy --update-aliases 4.4 latest
```

2. To deploy documentation for a new release:
2. To deploy documentation for stable release:

```bash
mike deploy --push --alias-type=copy 4.2 stable
Expand Down
2 changes: 1 addition & 1 deletion docs/manual/docs/help/record/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ Download the contents of a single record.
- A folder containing complete **`metadata.xml`** record, and simplified
***`metadata-iso19139.xml`*** record.
- ***`index.html`** and **`index.csv`** summary described in
the [previous section](#download-from-search-results).
the [previous section](../search/index.md#download-from-search-results).

![](img/export_record_zip.png)
*Export (ZIP) index.html summary*
Expand Down
8 changes: 4 additions & 4 deletions docs/manual/docs/overview/change-log/history/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Release History

The GeoNetwork community is not large enough to maintain many active branches of GeoNetwork at one time. Older installations of GeoNetwork may be subject to disclosed security vulnerabilities resulting in our recommendation to update to the supported [stable](http://docs.geonetwork-opensource.org/stable/) or [maintenance](https://docs.geonetwork-opensource.org/maintenance/) series if available.
The GeoNetwork community is not large enough to maintain many active branches of GeoNetwork at one time. Older installations of GeoNetwork may be subject to disclosed security vulnerabilities resulting in our recommendation to update to the supported [stable](#stable-release) or [maintenance](#maintenance-release) series listed below.

Volunteers wishing to backport security fixes to older versions of GeoNetwork are welcome to do so. Commercial support providers are welcome to do so on behalf of their customers.

## Latest Release

The latest release of GeoNetwork is recommended for those enjoying the newest features from the GeoNetwork community.

This series is under active development by our community, with new features, improvements, documentation updates, bug reports, fixes, and releases.
This series is under **active development** by our community, with new features, improvements, documentation updates, bug reports, fixes, and releases.

### 4.4

Expand All @@ -22,7 +22,7 @@ This series is under active development by our community, with new features, imp

The stable release of GeoNetwork is recommended for production use and for new installations of GeoNetwork.

This series is under active use by our community, with regular improvements, documentation updates, bug reports, fixes, and releases.
This series is under **active use** by our community, with regular improvements, documentation updates, bug reports, fixes, and releases.

### 4.2

Expand All @@ -41,7 +41,7 @@ This series is under active use by our community, with regular improvements, doc

The maintenance release of GeoNetwork provides production systems with essential updates and fixes to allow time to upgrade to the recommended stable release.

This series is no longer under active development, providing essential fixes, and releases only.
When available the maintenace series provides **time to upgrade** for our community - limited to providing essential fixes only.

### No maintenance release

Expand Down
File renamed without changes.

0 comments on commit cbeabf5

Please sign in to comment.