Skip to content

Commit 76eaa71

Browse files
authored
how to update mkdoc env (removed instructions for docker mkdocs use) (geonetwork#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
1 parent 7caa17e commit 76eaa71

File tree

4 files changed

+26
-15
lines changed

4 files changed

+26
-15
lines changed

docs/manual/README.md

+21-10
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ If you are using Python3:
2323
```bash
2424
pip3 install -r requirements.txt
2525
```
26+
27+
In the future you can update using:
28+
29+
```bash
30+
pip3 install -r requirements.txt -U
31+
```
2632

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

@@ -55,6 +61,13 @@ If you use a Python virtual environment:
5561
pip install -r requirements.txt
5662
```
5763

64+
In the future you can update with:
65+
66+
```bash
67+
source venv/bin/activate
68+
pip3 install -r requirements.txt
69+
```
70+
5871
2. Use ***mkdocs*** to preview from virtual environment:
5972

6073
```bash
@@ -63,18 +76,16 @@ If you use a Python virtual environment:
6376

6477
3. Preview: http://localhost:8000
6578

66-
### Docker
67-
68-
If you are not familiar with Python the MkDocs-material website has instructions for Docker:
69-
70-
1. Run MkDocs in Docker environment:
71-
79+
Preview uses a single version, so expect some warnings from version chooser:
7280
```
73-
docker pull squidfunk/mkdocs-material
74-
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
81+
"GET /versions.json HTTP/1.1" code 404
7582
```
83+
84+
4. Optional: Preview online help:
7685

77-
2. Preview: http://localhost:8000
86+
```bash
87+
mkdocs serve --config-file help.yml
88+
```
7889

7990
## Maven Integration
8091

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

111-
2. To deploy documentation for a new release:
122+
2. To deploy documentation for stable release:
112123

113124
```bash
114125
mike deploy --push --alias-type=copy 4.2 stable

docs/manual/docs/help/record/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ Download the contents of a single record.
194194
- A folder containing complete **`metadata.xml`** record, and simplified
195195
***`metadata-iso19139.xml`*** record.
196196
- ***`index.html`** and **`index.csv`** summary described in
197-
the [previous section](#download-from-search-results).
197+
the [previous section](../search/index.md#download-from-search-results).
198198

199199
![](img/export_record_zip.png)
200200
*Export (ZIP) index.html summary*

docs/manual/docs/overview/change-log/history/index.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Release History
22

3-
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.
3+
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.
44

55
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.
66

77
## Latest Release
88

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

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

1313
### 4.4
1414

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

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

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

2727
### 4.2
2828

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

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

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

4646
### No maintenance release
4747

File renamed without changes.

0 commit comments

Comments
 (0)