Skip to content

Commit e2881e1

Browse files
jodygarnettjosegar74
authored andcommitted
Use default mike settings to fix interaction between language chooser and versions
Adjust overview changelog navigation tree for latest This removes the concept of devel.
1 parent f8c0436 commit e2881e1

File tree

10 files changed

+160
-148
lines changed

10 files changed

+160
-148
lines changed

docs/manual/README.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -100,38 +100,40 @@ If you are not familiar with python the mkdocs-material website has instructions
100100

101101
We use ``mike`` for publishing to https://geonetwork.github.io using `<major>.<minor>` version:
102102

103-
1. To deploy SNAPSHOT development docs from the `main` branch to website `gh-pages` branch:
103+
1. To deploy docs from the `main` branch to website `gh-pages` branch:
104104

105105
```bash
106-
mike deploy --push --update-aliases 4.4 devel
106+
mike deploy --push --no-redirect --update-aliases 4.4 latest
107107
```
108108

109109
2. To deploy documentation for a new release:
110110

111111
```bash
112-
mike deploy --push --update-aliases 4.2 stable
112+
mike deploy --push --no-redirect --update-aliases 4.2 stable
113113
```
114114

115-
When starting a new branch you can make it the default:
115+
3. When starting a new branch you can make it the default:
116116

117117
```bash
118118
mike set-default --push 4.2
119119
```
120+
121+
Hint: When starting a new branch update `overview/changelog/` navigation tree also.
120122

121-
3. To publish documentation for a maintenance release:
123+
4. To publish documentation for a maintenance release:
122124

123125
```bash
124-
mike deploy --push --update-aliases 3.12 maintenance
126+
mike deploy --push --no-redirect --update-aliases 3.12 maintenance
125127
```
126128

127-
4. To show published versions:
129+
5. To show published versions:
128130

129131
```bash
130132

131133
mike list
132134
```
133135

134-
5. To preview things locally (uses your local ``gh-pages`` branch):
136+
6. To preview things locally (uses your local ``gh-pages`` branch):
135137

136138
```bash
137139
mike serve

docs/manual/docs/overview/change-log/archive.md

-90
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# Archived
2+
3+
The following series of GeoNetwork are no longer in active use and you are encouraged to migrate to a newer version.
4+
5+
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/index.md) or [maintenance](../maintenance/index.md) series.
6+
7+
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.
8+
9+
## 4.0.x
10+
11+
- [Version 4.0.6](../version-4.0.6.md)
12+
- [Version 4.0.5](../version-4.0.5.md)
13+
- [Version 4.0.4](../version-4.0.4.md)
14+
- [Version 4.0.3](../version-4.0.3.md)
15+
- [Version 4.0.2](../version-4.0.2.md)
16+
- [Version 4.0.1](../version-4.0.1.md)
17+
- [Version 4.0.0](../version-4.0.0.md)
18+
- [Version 4.0.0 Alpha.2](../version-4.0.0-alpha.2.md)
19+
- [Version 4.0.0 Alpha.1](../version-4.0.0-alpha.1.md)
20+
21+
## 3.10.x
22+
23+
- [Version 3.10.10](../version-3.10.10.md)
24+
- [Version 3.10.9](../version-3.10.9.md)
25+
- [Version 3.10.8](../version-3.10.8.md)
26+
- [Version 3.10.7](../version-3.10.7.md)
27+
- [Version 3.10.6](../version-3.10.6.md)
28+
- [Version 3.10.5](../version-3.10.5.md)
29+
- [Version 3.10.4](../version-3.10.4.md)
30+
- [Version 3.10.3](../version-3.10.3.md)
31+
- [Version 3.10.2](../version-3.10.2.md)
32+
- [Version 3.10.1](../version-3.10.1.md)
33+
- [Version 3.10.0](../version-3.10.0.md)
34+
- [Version 3.8.3](../version-3.8.3.md)
35+
- [Version 3.8.2](../version-3.8.2.md)
36+
- [Version 3.8.1](../version-3.8.1.md)
37+
- [Version 3.8.0](../version-3.8.0.md)
38+
- [Version 3.6.0](../version-3.6.0.md)
39+
- [Version 3.4.4](../version-3.4.4.md)
40+
- [Version 3.4.3](../version-3.4.3.md)
41+
- [Version 3.4.2](../version-3.4.2.md)
42+
- [Version 3.4.1](../version-3.4.1.md)
43+
- [Version 3.4.0](../version-3.4.0.md)
44+
- [Version 3.2.2](../version-3.2.2.md)
45+
- [Version 3.2.1](../version-3.2.1.md)
46+
- [Version 3.2.0](../version-3.2.0.md)
47+
- [Version 3.0.4](../version-3.0.4.md)
48+
- [Version 3.0.3](../version-3.0.3.md)
49+
- [Version 3.0.2](../version-3.0.2.md)
50+
- [Version 3.0.1](../version-3.0.1.md)
51+
- [Version 3.0.0](../version-3.0.0.md)
52+
53+
## 3.8.x
54+
55+
- [Version 3.8.3](../version-3.8.3.md)
56+
- [Version 3.8.2](../version-3.8.2.md)
57+
- [Version 3.8.1](../version-3.8.1.md)
58+
- [Version 3.8.0](../version-3.8.0.md)
59+
60+
## 3.6.x
61+
62+
- [Version 3.6.0](../version-3.6.0.md)
63+
64+
## 3.4.x
65+
66+
- [Version 3.4.4](../version-3.4.4.md)
67+
- [Version 3.4.3](../version-3.4.3.md)
68+
- [Version 3.4.2](../version-3.4.2.md)
69+
- [Version 3.4.1](../version-3.4.1.md)
70+
- [Version 3.4.0](../version-3.4.0.md)
71+
72+
## 3.2.x
73+
74+
- [Version 3.2.2](../version-3.2.2.md)
75+
- [Version 3.2.1](../version-3.2.1.md)
76+
- [Version 3.2.0](../version-3.2.0.md)
77+
78+
## 3.0.x
79+
80+
- [Version 3.0.4](../version-3.0.4.md)
81+
- [Version 3.0.3](../version-3.0.3.md)
82+
- [Version 3.0.2](../version-3.0.2.md)
83+
- [Version 3.0.1](../version-3.0.1.md)
84+
- [Version 3.0.0](../version-3.0.0.md)
85+
86+
## 2.10.x
87+
88+
All development has ceased:
89+
90+
* [User Manual v2.10.4-0](https://geonetwork-opensource.org/manuals/2.10.4/eng/users/index.html)

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

+4-3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
Notable changes made to a GeoNetwork-open source including new features, migration instructions, and bug fixes.
44

5-
- [Stable](stable.md)
6-
- [Maintenance](maintenance.md)
7-
- [Archive](archive.md)
5+
- [Latest](latest/index.md)
6+
- [Stable](stable/index.md)
7+
- [Maintenance](maintenance/index.md)
8+
- [Archive](archive/index.md)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Latest
2+
3+
GeoNetwork 4.4.x is recommended for those enjoying the newest features from the GeoNetwork community.
4+
5+
This series is under active development by our community, with new features, improvements, documentation updates, bug reports, fixes, and releases.
6+
7+
## Latest
8+
9+
- [Version 4.4.0](../version-4.4.0.md)
10+

docs/manual/docs/overview/change-log/maintenance.md

-22
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Maintenance
2+
3+
The GeoNetwork 4.2.x series is stable and recommended for production use and new installations of GeoNetwork.
4+
This series is under active use by our community, with regular improvements, documentation updates, bug reports, fixes, and releases.
5+
6+
## Latest
7+
8+
* [Version 3.12.11](../version-3.12.11.md)
9+
10+
## History
11+
12+
* [Version 3.12.10](../version-3.12.10.md)
13+
* [Version 3.12.9](../version-3.12.9.md)
14+
* [Version 3.12.8](../version-3.12.8.md)
15+
* [Version 3.12.7](../version-3.12.7.md)
16+
* [Version 3.12.6](../version-3.12.6.md)
17+
* [Version 3.12.5](../version-3.12.5.md)
18+
* [Version 3.12.4](../version-3.12.4.md)
19+
* [Version 3.12.3](../version-3.12.3.md)
20+
* [Version 3.12.3](../version-3.12.2.md)
21+
* [Version 3.12.1](../version-3.12.1.md)
22+
* [Version 3.12.0](../version-3.12.0.md)

docs/manual/docs/overview/change-log/stable.md

-19
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Stable
2+
3+
The GeoNetwork 4.2.x series is stable and recommended for production use and new installations of GeoNetwork.
4+
This series is under active use by our community, with regular improvements, documentation updates, bug reports, fixes, and releases.
5+
6+
## Latest
7+
8+
- [Version 4.2.6](../version-4.2.6.md)
9+
10+
11+
## History
12+
13+
- [Version 4.2.5](../version-4.2.5.md)
14+
- [Version 4.2.4](../version-4.2.4.md)
15+
- [Version 4.2.3](../version-4.2.3.md)
16+
- [Version 4.2.2](../version-4.2.2.md)
17+
- [Version 4.2.1](../version-4.2.1.md)
18+
- [Version 4.2.0](../version-4.2.0.md)

docs/manual/mkdocs.yml

+6-6
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,6 @@ plugins:
7878
- exclude:
7979
glob:
8080
- annexes/gallery/bin/README.md
81-
- mike:
82-
canonical_version: stable
8381

8482
# Customizations
8583
extra:
@@ -138,9 +136,11 @@ nav:
138136
- overview/authors.md
139137
- 'Changelog':
140138
- overview/change-log/index.md
141-
- 'Stable':
142-
- overview/change-log/stable.md
139+
- 'Latest':
140+
- overview/change-log/latest/index.md
143141
- overview/change-log/version-4.4.0.md
142+
- 'Stable':
143+
- overview/change-log/stable/index.md
144144
- overview/change-log/version-4.2.6.md
145145
- overview/change-log/version-4.2.5.md
146146
- overview/change-log/version-4.2.4.md
@@ -149,7 +149,7 @@ nav:
149149
- overview/change-log/version-4.2.1.md
150150
- overview/change-log/version-4.2.0.md
151151
- 'Maintenance':
152-
- overview/change-log/maintenance.md
152+
- overview/change-log/maintenance/index.md
153153
- overview/change-log/version-3.12.11.md
154154
- overview/change-log/version-3.12.10.md
155155
- overview/change-log/version-3.12.9.md
@@ -163,7 +163,7 @@ nav:
163163
- overview/change-log/version-3.12.1.md
164164
- overview/change-log/version-3.12.0.md
165165
- 'Archive':
166-
- overview/change-log/archive.md
166+
- overview/change-log/archive/index.md
167167
- overview/change-log/version-4.0.6.md
168168
- overview/change-log/version-4.0.5.md
169169
- overview/change-log/version-4.0.4.md

0 commit comments

Comments
 (0)