From 3e76ef7b5bcfd5f7d9dc6854135d2de47e108c74 Mon Sep 17 00:00:00 2001 From: Mark Olesen Date: Mon, 9 Dec 2019 14:37:51 +0100 Subject: [PATCH] DOC: update repository links --- README.md | 33 +++++++++++++++++---------------- doc/Build.md | 22 +++++++++++----------- doc/BuildIssues.md | 20 ++++++++++---------- doc/Doxygen/Allwmake | 4 +--- doc/Requirements.md | 14 +++++++------- 5 files changed, 46 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index ac3aeb783f..f04e43fdde 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@ # About OpenFOAM -OpenFOAM is a free, open source CFD software [released and developed primarily by OpenCFD Ltd](http://www.openfoam.com) since 2004. It has a large user base across most areas of engineering and science, from both commercial and academic organisations. OpenFOAM has an extensive range of features to solve anything from complex fluid flows involving chemical reactions, turbulence and heat transfer, to acoustics, solid mechanics and electromagnetics. [More...](http://www.openfoam.com/documentation) - +OpenFOAM is a free, open source CFD software [released and developed by OpenCFD Ltd since 2004](http://www.openfoam.com/history/). +It has a large user base across most areas of engineering and science, from both commercial and academic organisations. +OpenFOAM has an extensive range of features to solve anything from complex fluid flows involving chemical reactions, turbulence and heat transfer, to acoustics, solid mechanics and electromagnetics. +[See documentation](http://www.openfoam.com/documentation) OpenFOAM is professionally released every six months to include customer sponsored developments and contributions from the community - -individual and group contributors, re-integrations (including from -FOAM-extend and OpenFOAM Foundation Ltd) - in this Official Release -sanctioned by the OpenFOAM Worldwide Trademark Owner aiming towards -one OpenFOAM. +individual and group contributors, integrations +(eg, from FOAM-extend and OpenFOAM Foundation Ltd) as well as +[governance guided activities](https://www.openfoam.com/governance/). # Copyright @@ -168,17 +169,17 @@ ThirdParty directory will contain either an `Allwmake` file or a -[repo openfoam]: https://develop.openfoam.com/Development/OpenFOAM-plus/ -[repo third]: https://develop.openfoam.com/Development/ThirdParty-plus/ +[repo openfoam]: https://develop.openfoam.com/Development/openfoam/ +[repo third]: https://develop.openfoam.com/Development/ThirdParty-common/ -[link openfoam-readme]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/README.md -[link openfoam-issues]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/doc/BuildIssues.md -[link openfoam-config]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/doc/Config.md -[link openfoam-build]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/doc/Build.md -[link openfoam-require]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/doc/Requirements.md -[link third-readme]: https://develop.openfoam.com/Development/ThirdParty-plus/blob/develop/README.md -[link third-build]: https://develop.openfoam.com/Development/ThirdParty-plus/blob/develop/BUILD.md -[link third-require]: https://develop.openfoam.com/Development/ThirdParty-plus/blob/develop/Requirements.md +[link openfoam-readme]: https://develop.openfoam.com/Development/openfoam/blob/develop/README.md +[link openfoam-issues]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/BuildIssues.md +[link openfoam-config]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/Config.md +[link openfoam-build]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/Build.md +[link openfoam-require]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/Requirements.md +[link third-readme]: https://develop.openfoam.com/Development/ThirdParty-common/blob/develop/README.md +[link third-build]: https://develop.openfoam.com/Development/ThirdParty-common/blob/develop/BUILD.md +[link third-require]: https://develop.openfoam.com/Development/ThirdParty-common/blob/develop/Requirements.md # Useful Links diff --git a/doc/Build.md b/doc/Build.md index 8578c10737..c96d48bea0 100644 --- a/doc/Build.md +++ b/doc/Build.md @@ -122,18 +122,18 @@ More details in the [ThirdParty build guide][link third-build]. -[repo openfoam]: https://develop.openfoam.com/Development/OpenFOAM-plus/ -[repo third]: https://develop.openfoam.com/Development/ThirdParty-plus/ +[repo openfoam]: https://develop.openfoam.com/Development/openfoam/ +[repo third]: https://develop.openfoam.com/Development/ThirdParty-common/ -[link openfoam-readme]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/README.md -[link openfoam-issues]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/doc/BuildIssues.md -[link openfoam-config]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/doc/Config.md -[link openfoam-build]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/doc/Build.md -[link openfoam-cross]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/doc/Cross-Compile-mingw.md -[link openfoam-require]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/doc/Requirements.md -[link third-readme]: https://develop.openfoam.com/Development/ThirdParty-plus/blob/develop/README.md -[link third-build]: https://develop.openfoam.com/Development/ThirdParty-plus/blob/develop/BUILD.md -[link third-require]: https://develop.openfoam.com/Development/ThirdParty-plus/blob/develop/Requirements.md +[link openfoam-readme]: https://develop.openfoam.com/Development/openfoam/blob/develop/README.md +[link openfoam-issues]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/BuildIssues.md +[link openfoam-config]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/Config.md +[link openfoam-build]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/Build.md +[link openfoam-cross]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/Cross-Compile-mingw.md +[link openfoam-require]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/Requirements.md +[link third-readme]: https://develop.openfoam.com/Development/ThirdParty-common/blob/develop/README.md +[link third-build]: https://develop.openfoam.com/Development/ThirdParty-common/blob/develop/BUILD.md +[link third-require]: https://develop.openfoam.com/Development/ThirdParty-common/blob/develop/Requirements.md --- Copyright 2019 OpenCFD Ltd diff --git a/doc/BuildIssues.md b/doc/BuildIssues.md index 9b8e10cadd..db7db5539c 100644 --- a/doc/BuildIssues.md +++ b/doc/BuildIssues.md @@ -110,17 +110,17 @@ and attempt to install a `paraview~qt` version instead. -[repo openfoam]: https://develop.openfoam.com/Development/OpenFOAM-plus/ -[repo third]: https://develop.openfoam.com/Development/ThirdParty-plus/ +[repo openfoam]: https://develop.openfoam.com/Development/openfoam/ +[repo third]: https://develop.openfoam.com/Development/ThirdParty-common/ -[link openfoam-readme]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/README.md -[link openfoam-issues]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/doc/BuildIssues.md -[link openfoam-config]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/doc/Config.md -[link openfoam-build]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/doc/Build.md -[link openfoam-require]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/doc/Requirements.md -[link third-readme]: https://develop.openfoam.com/Development/ThirdParty-plus/blob/develop/README.md -[link third-build]: https://develop.openfoam.com/Development/ThirdParty-plus/blob/develop/BUILD.md -[link third-require]: https://develop.openfoam.com/Development/ThirdParty-plus/blob/develop/Requirements.md +[link openfoam-readme]: https://develop.openfoam.com/Development/openfoam/blob/develop/README.md +[link openfoam-issues]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/BuildIssues.md +[link openfoam-config]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/Config.md +[link openfoam-build]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/Build.md +[link openfoam-require]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/Requirements.md +[link third-readme]: https://develop.openfoam.com/Development/ThirdParty-common/blob/develop/README.md +[link third-build]: https://develop.openfoam.com/Development/ThirdParty-common/blob/develop/BUILD.md +[link third-require]: https://develop.openfoam.com/Development/ThirdParty-common/blob/develop/Requirements.md --- Copyright 2019 OpenCFD Ltd diff --git a/doc/Doxygen/Allwmake b/doc/Doxygen/Allwmake index a765bc363f..856e28b0e7 100755 --- a/doc/Doxygen/Allwmake +++ b/doc/Doxygen/Allwmake @@ -30,8 +30,7 @@ USAGE # ----------------------------------------------------------------------------- defineURL() { - WEB_PATH="https://develop.openfoam.com" - FOAM_REPO_VERSION="$WM_PROJECT-plus" + export FOAM_BASE_REPO="https://develop.openfoam.com/Development/openfoam" case "$WM_PROJECT_VERSION" in v[1-9][.0-9]*) @@ -42,7 +41,6 @@ defineURL() { ;; esac - export FOAM_BASE_REPO="$WEB_PATH/Development/$FOAM_REPO_VERSION" export FOAM_ONLINE_REPO="$FOAM_BASE_REPO/blob/${FOAM_REPO_TAG}" } diff --git a/doc/Requirements.md b/doc/Requirements.md index a78bbd53cc..717fe8eabc 100644 --- a/doc/Requirements.md +++ b/doc/Requirements.md @@ -161,13 +161,13 @@ A partial list is given in the [ThirdParty requirements][link third-require]. -[link openfoam-readme]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/README.md -[link openfoam-config]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/doc/Config.md -[link openfoam-build]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/doc/Build.md -[link openfoam-require]: https://develop.openfoam.com/Development/OpenFOAM-plus/blob/develop/doc/Requirements.md -[link third-readme]: https://develop.openfoam.com/Development/ThirdParty-plus/blob/develop/README.md -[link third-build]: https://develop.openfoam.com/Development/ThirdParty-plus/blob/develop/BUILD.md -[link third-require]: https://develop.openfoam.com/Development/ThirdParty-plus/blob/develop/Requirements.md +[link openfoam-readme]: https://develop.openfoam.com/Development/openfoam/blob/develop/README.md +[link openfoam-config]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/Config.md +[link openfoam-build]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/Build.md +[link openfoam-require]: https://develop.openfoam.com/Development/openfoam/blob/develop/doc/Requirements.md +[link third-readme]: https://develop.openfoam.com/Development/ThirdParty-common/blob/develop/README.md +[link third-build]: https://develop.openfoam.com/Development/ThirdParty-common/blob/develop/BUILD.md +[link third-require]: https://develop.openfoam.com/Development/ThirdParty-common/blob/develop/Requirements.md --- Copyright 2019 OpenCFD Ltd