Skip to content

update external docs urls #1010

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
cmarooney-stfc wants to merge 8 commits into
base: master
Choose a base branch
from
Draft

update external docs urls #1010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4f10153
update external docs urls
cmarooney-stfc Apr 14, 2023
fe5d4e4
correct spelling
cmarooney-stfc Apr 14, 2023
aa4108c
regularise endings
cmarooney-stfc Apr 14, 2023
feef5b7
respond to comments
cmarooney-stfc Apr 17, 2023
28ec4c3
correct path
cmarooney-stfc Apr 17, 2023
af51109
more typos
cmarooney-stfc Apr 17, 2023
13529cb
add to docs for release deployment
cmarooney-stfc Apr 17, 2023
4d38ce2
cross reference
cmarooney-stfc Apr 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion documentation/smg/10_build_release_process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,11 @@ The version number is stored in a text file (`VERSION`) in the root of the
Herbert and Horace source.
This will follow [semantic versioning](https://semver.org/)
and is used in the build process to set the version number in the MATLAB
and compiled C++ components.
and compiled C++ components

The number of the latest version is referred to in README.md in
`documentation/user_docs`. When updating the release as above, that reference
in the README should also be updated.

## Deployment on ISIS computational services machines

Expand Down
21 changes: 17 additions & 4 deletions documentation/user_docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,23 @@ To build the docs locally:
Built documents will be put in the `/build/html` folder, the main file is the `index.html` file.

## Online documentation
Horace documentation is also available from:
The latest stable Horace documentation is also available from:

https://pace-neutrons.github.io/horace-docs/latest
https://pace-neutrons.github.io/Horace/stable

For this version, see:
where `/stable` can be omitted. The latest development version of the
documentation can be obtained by replacing `stable` with `unstable`.

https://pace-neutrons.github.io/horace-docs/3.5.0/
`Horace` and `Horace/stable` both immediately redirect to the path of the
Copy link
Collaborator

@oerc0122 oerc0122 Apr 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should probably note in <horace>/documentation/smg/10_build_release_process.md#releases that as part of the release cycle we update this README.md

latest stable version, which is currently:

https://pace-neutrons.github.io/Horace/v3.6.3/

This version number should be changed when a new release is produced; details
for this can be found in `smg/10_build_release_process.md`.

Older versions are available; to see these, enter the Horace repo at the
top level and switch to branch `gh-pages`.

Details on the use of this branch to store release documentation can be
found in `adr/0002-use-github-for-documentation.md`.