From def44f210cab53e197482318279b4de953fb9493 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 15 Jun 2022 14:46:23 +0200 Subject: [PATCH] chore: remove obsolete configuration files (#2378) * chore: remove obsolete linkchecker configuration file * chore: remove obsolete package.json configuration file * chore: remove obsolete antora maintainance procedure * chore: update .dockerignore * chore: update get_vale_styles.sh * fix: broken link * chore: remove obsolete configuration file --- .dockerignore | 5 +- .htmltest.yml | 1 - .pre-commit-config.yaml | 39 --------------- linkcheckerrc | 48 ------------------- ...-custom-branding-values-for-che-theia.adoc | 2 +- .../partials/ref_about-hosted-che.adoc | 2 +- package.json | 8 ---- ...rading-a-local-installation-of-antora.adoc | 31 ------------ tools/get_vale_styles.sh | 4 +- 9 files changed, 8 insertions(+), 132 deletions(-) delete mode 100644 .pre-commit-config.yaml delete mode 100644 linkcheckerrc delete mode 100644 package.json delete mode 100644 proc_upgrading-a-local-installation-of-antora.adoc diff --git a/.dockerignore b/.dockerignore index 8ccae174f2..ce5dd0956a 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,3 +1,4 @@ .git -src/main/images -src/main/_site +modules +supplemental-ui +tools diff --git a/.htmltest.yml b/.htmltest.yml index 36d17592fc..52f378e9ef 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -22,7 +22,6 @@ IgnoreURLs: - https://github.com/eclipse-che/che-docs/edit/main/ - https://www.eclipse.org/che/docs/che-7/ - https://projectlombok.org/ - - https://developers.redhat.com/products/openshift_dev_spaces/overview - https://developers.redhat.com/products/openshift-dev-spaces/overview - https://docs.github.com/en/* - https://velero.io/* diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml deleted file mode 100644 index e173314ceb..0000000000 --- a/.pre-commit-config.yaml +++ /dev/null @@ -1,39 +0,0 @@ ---- -# .pre-commit-config.yaml -# See https://pre-commit.com for more information -# See https://pre-commit.com/hooks.html for more hooks -# fail_fast: true -repos: - - repo: meta - hooks: - - id: check-hooks-apply - - id: check-useless-excludes - - id: identity - name: List files to watch - - repo: local - hooks: - - id: antora - name: Build documentation with Antora - description: Build documentation with Antora - language: docker_image - entry: docker.io/antora/antora antora-playbook-for-development.yml - pass_filenames: false - always_run: true - verbose: true - require_serial: false - - id: vale - name: Validate Style Guide with Vale - description: Validate Style Guide with Vale - language: docker_image - entry: docker.io/jdkato/vale - pass_filenames: true - always_run: false - verbose: true - require_serial: false - - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v2.4.0 - hooks: - - id: trailing-whitespace - - id: end-of-file-fixer - - id: check-yaml - - id: check-added-large-files diff --git a/linkcheckerrc b/linkcheckerrc deleted file mode 100644 index be70f41007..0000000000 --- a/linkcheckerrc +++ /dev/null @@ -1,48 +0,0 @@ -[checking] - -# Files larger than NUMBER bytes will be ignored, without downloading anything if accessed over http and an accurate Content-Length header was returned. No more than this amount of a file will be downloaded. The default is 5242880 (5 MB). 67108860 = 64M. Increased to avoid false positives on anchors checks. -maxfilesizedownload=67108860 - -# Files larger than NUMBER bytes will not be parsed for links. The default is 1048576 (1 MB). 67108860 = 64M. Increased to avoid false positives on anchors checks. -maxfilesizeparse=67108860 - -# When using http, fetch robots.txt, and confirm whether each URL should be accessed before checking. The default is to use robots.txt files. Disabled to avoid false positives on anchors checks. -robotstxt=0 - -# Generate no more than the given number of threads. Default number of threads is 10. To disable threading specify a non-positive number. Disabled to avoid false positives on anchors checks. -threads=-1 - -# Checks validity of HTML anchors. -[AnchorCheck] - -[output] - -# Output to a file linkchecker-out.html. Valid file output types are text, html, sql, csv, gml, dot, xml, none or failures. Default is no file output. -fileoutput=html - -[text] - -# Comma-separated list of parts that have to be logged. -parts=parenturl,url,realurl,warning,result,intro,outro - -[filtering] - -# Check external links. Default is to check internal links only. -checkextern=1 - -# Ignore the comma-separated list of warnings. -ignorewarnings=url-rate-limited - -# URLs matching the given regular expression will be ignored and not checked. -# Multiline option. Each line has to be indented for that to work. -# Lines starting with a hash (#) will be ignored, though they must still be indented. -ignore= - file:///projects* - http://che.aws.my-ide.cloud - https://console.aws.amazon.com/* - https://github.com/eclipse/che-devfile-registry/blob/main/devfiles/quarkus-command-mode/devfile.yaml#L* - https://maven.apache.org/settings.html* - https://github.com/eclipse/che-docs/edit/main/* - https://workspaces.openshift.com/* - https://www.eclipse.org/che/docs/che-7/* - https://che-plugin-registry.openshift.io/* diff --git a/modules/administration-guide/partials/proc_defining-custom-branding-values-for-che-theia.adoc b/modules/administration-guide/partials/proc_defining-custom-branding-values-for-che-theia.adoc index 2bd0573b7f..c286c0e95f 100644 --- a/modules/administration-guide/partials/proc_defining-custom-branding-values-for-che-theia.adoc +++ b/modules/administration-guide/partials/proc_defining-custom-branding-values-for-che-theia.adoc @@ -27,7 +27,7 @@ Create a `product.json` file with a new name of the product, logo, description, "links": { <5> "website": { "name": "Discover {rh-os-devspaces}", - "url": "https://developers.redhat.com/products/openshift_dev_spaces/overview" + "url": "https://developers.redhat.com/products/openshift-dev-spaces/overview" }, "documentation": { "name": "Browse Documentation", diff --git a/modules/hosted-che/partials/ref_about-hosted-che.adoc b/modules/hosted-che/partials/ref_about-hosted-che.adoc index 4829c6fe93..a06fa4d9ec 100644 --- a/modules/hosted-che/partials/ref_about-hosted-che.adoc +++ b/modules/hosted-che/partials/ref_about-hosted-che.adoc @@ -7,7 +7,7 @@ = About Eclipse Che hosted by Red Hat Eclipse Che hosted by Red Hat is an open source product based on link:https://www.eclipse.org/che/[Eclipse {prod-short}] that is running on link:https://www.openshift.com/products/dedicated/[OpenShift Dedicated]. -The new service is part of the link:https://developers.redhat.com/developer-sandbox[Developer Sandbox for Red Hat OpenShift] offering, and is using link:https://developers.redhat.com/products/openshift_dev_spaces/overview[{rh-os-devspaces}], which is built upon Eclipse Che and is optimized for Red Hat OpenShift and Red Hat Linux. +The new service is part of the link:https://developers.redhat.com/developer-sandbox[Developer Sandbox for Red Hat OpenShift] offering, and is using link:https://developers.redhat.com/products/openshift-dev-spaces/overview[{rh-os-devspaces}], which is built upon Eclipse Che and is optimized for Red Hat OpenShift and Red Hat Linux. == Differences between Eclipse Che and {rh-os-devspaces} diff --git a/package.json b/package.json deleted file mode 100644 index 74b7dfa4d5..0000000000 --- a/package.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "dependencies": { - "@antora/site-generator-default": "^2.3.4", - "gulp": "^4.0.2", - "gulp-cli": "^2.3.0", - "gulp-connect": "^5.7.0" - } -} diff --git a/proc_upgrading-a-local-installation-of-antora.adoc b/proc_upgrading-a-local-installation-of-antora.adoc deleted file mode 100644 index acca2a61f9..0000000000 --- a/proc_upgrading-a-local-installation-of-antora.adoc +++ /dev/null @@ -1,31 +0,0 @@ - - -[id="upgrading-a-local-installation-of-antora_{context}"] -= Upgrading a local installation of Antora - -This section describes how to upgrade a local installation of Antora. - -.Prerequisites - -* A running version of yarn. See link:https://yarnpkg.com/getting-started/install[Installing Yarn]. -* `./node_modules/.bin` is in the `PATH` environment variable. - -.Procedure - -. Open a shell into the project directory and run following command: -+ ----- -$ yarn upgrade ----- - -. Commit the changes in both files `package.json` and `package-lock.json`. -+ ----- -$ git add package.json yarn.lock -$ git commit -m "Upgrade Antora to new version" ----- - -.Verification steps - -. Build the documentation as usual - diff --git a/tools/get_vale_styles.sh b/tools/get_vale_styles.sh index 2fab5cca24..82a2f4debe 100755 --- a/tools/get_vale_styles.sh +++ b/tools/get_vale_styles.sh @@ -12,9 +12,11 @@ set -e # Get fresh Vale styles +mkdir -p .vale/styles cd .vale/styles || exit -rm -rf RedHat CheDocs +rm -rf RedHat CheDocs RedHat.zip CheDocs.zip wget -q https://github.com/redhat-documentation/vale-at-red-hat/releases/latest/download/RedHat.zip unzip -q RedHat.zip wget -q https://github.com/eclipse-che/che-docs-vale-style/releases/latest/download/CheDocs.zip unzip -q CheDocs.zip +echo "Downloaded fresh 'CheDocs' and 'RedHat' Vale styles"