Skip to content

Commit

Permalink
Use default mike settings to fix interaction between language chooser…
Browse files Browse the repository at this point in the history
… and versions

Adjust overview changelog navigation tree for latest

This removes the concept of devel.
  • Loading branch information
jodygarnett authored and josegar74 committed Oct 4, 2023
1 parent f8c0436 commit e2881e1
Show file tree
Hide file tree
Showing 10 changed files with 160 additions and 148 deletions.
18 changes: 10 additions & 8 deletions docs/manual/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,38 +100,40 @@ If you are not familiar with python the mkdocs-material website has instructions

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

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

```bash
mike deploy --push --update-aliases 4.4 devel
mike deploy --push --no-redirect --update-aliases 4.4 latest
```

2. To deploy documentation for a new release:

```bash
mike deploy --push --update-aliases 4.2 stable
mike deploy --push --no-redirect --update-aliases 4.2 stable
```

When starting a new branch you can make it the default:
3. When starting a new branch you can make it the default:

```bash
mike set-default --push 4.2
```

Hint: When starting a new branch update `overview/changelog/` navigation tree also.

3. To publish documentation for a maintenance release:
4. To publish documentation for a maintenance release:

```bash
mike deploy --push --update-aliases 3.12 maintenance
mike deploy --push --no-redirect --update-aliases 3.12 maintenance
```

4. To show published versions:
5. To show published versions:

```bash

mike list
```

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

```bash
mike serve
Expand Down
90 changes: 0 additions & 90 deletions docs/manual/docs/overview/change-log/archive.md

This file was deleted.

90 changes: 90 additions & 0 deletions docs/manual/docs/overview/change-log/archive/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# Archived

The following series of GeoNetwork are no longer in active use and you are encouraged to migrate to a newer version.

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.

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.

## 4.0.x

- [Version 4.0.6](../version-4.0.6.md)
- [Version 4.0.5](../version-4.0.5.md)
- [Version 4.0.4](../version-4.0.4.md)
- [Version 4.0.3](../version-4.0.3.md)
- [Version 4.0.2](../version-4.0.2.md)
- [Version 4.0.1](../version-4.0.1.md)
- [Version 4.0.0](../version-4.0.0.md)
- [Version 4.0.0 Alpha.2](../version-4.0.0-alpha.2.md)
- [Version 4.0.0 Alpha.1](../version-4.0.0-alpha.1.md)

## 3.10.x

- [Version 3.10.10](../version-3.10.10.md)
- [Version 3.10.9](../version-3.10.9.md)
- [Version 3.10.8](../version-3.10.8.md)
- [Version 3.10.7](../version-3.10.7.md)
- [Version 3.10.6](../version-3.10.6.md)
- [Version 3.10.5](../version-3.10.5.md)
- [Version 3.10.4](../version-3.10.4.md)
- [Version 3.10.3](../version-3.10.3.md)
- [Version 3.10.2](../version-3.10.2.md)
- [Version 3.10.1](../version-3.10.1.md)
- [Version 3.10.0](../version-3.10.0.md)
- [Version 3.8.3](../version-3.8.3.md)
- [Version 3.8.2](../version-3.8.2.md)
- [Version 3.8.1](../version-3.8.1.md)
- [Version 3.8.0](../version-3.8.0.md)
- [Version 3.6.0](../version-3.6.0.md)
- [Version 3.4.4](../version-3.4.4.md)
- [Version 3.4.3](../version-3.4.3.md)
- [Version 3.4.2](../version-3.4.2.md)
- [Version 3.4.1](../version-3.4.1.md)
- [Version 3.4.0](../version-3.4.0.md)
- [Version 3.2.2](../version-3.2.2.md)
- [Version 3.2.1](../version-3.2.1.md)
- [Version 3.2.0](../version-3.2.0.md)
- [Version 3.0.4](../version-3.0.4.md)
- [Version 3.0.3](../version-3.0.3.md)
- [Version 3.0.2](../version-3.0.2.md)
- [Version 3.0.1](../version-3.0.1.md)
- [Version 3.0.0](../version-3.0.0.md)

## 3.8.x

- [Version 3.8.3](../version-3.8.3.md)
- [Version 3.8.2](../version-3.8.2.md)
- [Version 3.8.1](../version-3.8.1.md)
- [Version 3.8.0](../version-3.8.0.md)

## 3.6.x

- [Version 3.6.0](../version-3.6.0.md)

## 3.4.x

- [Version 3.4.4](../version-3.4.4.md)
- [Version 3.4.3](../version-3.4.3.md)
- [Version 3.4.2](../version-3.4.2.md)
- [Version 3.4.1](../version-3.4.1.md)
- [Version 3.4.0](../version-3.4.0.md)

## 3.2.x

- [Version 3.2.2](../version-3.2.2.md)
- [Version 3.2.1](../version-3.2.1.md)
- [Version 3.2.0](../version-3.2.0.md)

## 3.0.x

- [Version 3.0.4](../version-3.0.4.md)
- [Version 3.0.3](../version-3.0.3.md)
- [Version 3.0.2](../version-3.0.2.md)
- [Version 3.0.1](../version-3.0.1.md)
- [Version 3.0.0](../version-3.0.0.md)

## 2.10.x

All development has ceased:

* [User Manual v2.10.4-0](https://geonetwork-opensource.org/manuals/2.10.4/eng/users/index.html)
7 changes: 4 additions & 3 deletions docs/manual/docs/overview/change-log/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

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

- [Stable](stable.md)
- [Maintenance](maintenance.md)
- [Archive](archive.md)
- [Latest](latest/index.md)
- [Stable](stable/index.md)
- [Maintenance](maintenance/index.md)
- [Archive](archive/index.md)
10 changes: 10 additions & 0 deletions docs/manual/docs/overview/change-log/latest/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Latest

GeoNetwork 4.4.x 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.

## Latest

- [Version 4.4.0](../version-4.4.0.md)

22 changes: 0 additions & 22 deletions docs/manual/docs/overview/change-log/maintenance.md

This file was deleted.

22 changes: 22 additions & 0 deletions docs/manual/docs/overview/change-log/maintenance/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Maintenance

The GeoNetwork 4.2.x series is stable and recommended for production use and new installations of GeoNetwork.
This series is under active use by our community, with regular improvements, documentation updates, bug reports, fixes, and releases.

## Latest

* [Version 3.12.11](../version-3.12.11.md)

## History

* [Version 3.12.10](../version-3.12.10.md)
* [Version 3.12.9](../version-3.12.9.md)
* [Version 3.12.8](../version-3.12.8.md)
* [Version 3.12.7](../version-3.12.7.md)
* [Version 3.12.6](../version-3.12.6.md)
* [Version 3.12.5](../version-3.12.5.md)
* [Version 3.12.4](../version-3.12.4.md)
* [Version 3.12.3](../version-3.12.3.md)
* [Version 3.12.3](../version-3.12.2.md)
* [Version 3.12.1](../version-3.12.1.md)
* [Version 3.12.0](../version-3.12.0.md)
19 changes: 0 additions & 19 deletions docs/manual/docs/overview/change-log/stable.md

This file was deleted.

18 changes: 18 additions & 0 deletions docs/manual/docs/overview/change-log/stable/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Stable

The GeoNetwork 4.2.x series is stable and recommended for production use and new installations of GeoNetwork.
This series is under active use by our community, with regular improvements, documentation updates, bug reports, fixes, and releases.

## Latest

- [Version 4.2.6](../version-4.2.6.md)


## History

- [Version 4.2.5](../version-4.2.5.md)
- [Version 4.2.4](../version-4.2.4.md)
- [Version 4.2.3](../version-4.2.3.md)
- [Version 4.2.2](../version-4.2.2.md)
- [Version 4.2.1](../version-4.2.1.md)
- [Version 4.2.0](../version-4.2.0.md)
12 changes: 6 additions & 6 deletions docs/manual/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,6 @@ plugins:
- exclude:
glob:
- annexes/gallery/bin/README.md
- mike:
canonical_version: stable

# Customizations
extra:
Expand Down Expand Up @@ -138,9 +136,11 @@ nav:
- overview/authors.md
- 'Changelog':
- overview/change-log/index.md
- 'Stable':
- overview/change-log/stable.md
- 'Latest':
- overview/change-log/latest/index.md
- overview/change-log/version-4.4.0.md
- 'Stable':
- overview/change-log/stable/index.md
- overview/change-log/version-4.2.6.md
- overview/change-log/version-4.2.5.md
- overview/change-log/version-4.2.4.md
Expand All @@ -149,7 +149,7 @@ nav:
- overview/change-log/version-4.2.1.md
- overview/change-log/version-4.2.0.md
- 'Maintenance':
- overview/change-log/maintenance.md
- overview/change-log/maintenance/index.md
- overview/change-log/version-3.12.11.md
- overview/change-log/version-3.12.10.md
- overview/change-log/version-3.12.9.md
Expand All @@ -163,7 +163,7 @@ nav:
- overview/change-log/version-3.12.1.md
- overview/change-log/version-3.12.0.md
- 'Archive':
- overview/change-log/archive.md
- overview/change-log/archive/index.md
- overview/change-log/version-4.0.6.md
- overview/change-log/version-4.0.5.md
- overview/change-log/version-4.0.4.md
Expand Down

0 comments on commit e2881e1

Please sign in to comment.