Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
116 commits
Select commit Hold shift + click to select a range
1f1ceaa
procedures: Setting Authorization callback URL in GitHub OAuth app to…
xbaran4 Dec 8, 2021
48aea14
chore: delete Jenkinsfile (#2190)
themr0c Dec 9, 2021
09d0b8c
fix: broken link (#2185)
themr0c Dec 9, 2021
51da2b6
release: Bump version to 7.40.1 (#2192)
che-bot Dec 9, 2021
2303e2a
fix: typo (#2186)
themr0c Dec 9, 2021
d6eea3e
fix: Add [hH]ostname (#2184)
themr0c Dec 9, 2021
6f1481f
procedures: Dev Workspace monitoring documentation (#2161)
dkwon17 Dec 9, 2021
7491147
fix: Fix attribute in Uninstalling Che (#2189)
tstastna Dec 10, 2021
0ad8705
chore: prepare master branch for multiversioned publication (#2193)
themr0c Dec 10, 2021
e47498b
chore: delete obsolete and unused vale vocabulary (#2188)
themr0c Dec 10, 2021
e151691
chore: speed up build on pulls (#2194)
themr0c Dec 10, 2021
954e848
chore: automate drafts column in the GitHub project (#2195)
themr0c Dec 10, 2021
0b802f5
fix: architecture overview xref statements (#2182)
themr0c Dec 10, 2021
cb1a899
chore: Adding Call publication builder workflow (#2197)
themr0c Dec 13, 2021
264ef44
release: Next (minor) version in master is 7.41 (#2198)
che-bot Dec 16, 2021
257ad56
chore: URLs changes (#2201)
themr0c Dec 16, 2021
fbcdd58
procedures: Configuring the CheCluster Custom Resource (#2136)
tstastna Dec 22, 2021
68e0aef
procedures: native user auth docs (#2187)
sparkoo Dec 22, 2021
1defabe
chore: externalize Vale styles (for the master branch) (#2200)
themr0c Dec 22, 2021
ef68ba5
chore: new GitHub organization for Vale styles (#2210)
themr0c Jan 14, 2022
72ccb6d
chore: flag master as a prerelease (#2211)
themr0c Jan 14, 2022
a47d33b
chore: enable container update (#2212)
themr0c Jan 18, 2022
efea8d0
fix: fix build errors and warnings (#2215)
themr0c Jan 21, 2022
a859202
chore: location for eclipse-che/che-docs-vale-style (#2216)
themr0c Jan 24, 2022
602f89d
chore: align master pr workflow on main (#2217)
themr0c Jan 25, 2022
55294c5
docs: rebranding of Che4z content to remove "CA" from product names (…
zeibura Jan 25, 2022
9460820
chore: download vale styles on the push workflow
themr0c Jan 25, 2022
0fc2d92
procedures: rewrite and expand the "Backup and disaster recovery" sec…
max-cx Jan 25, 2022
ad67911
procedures: Setting up GitLab OAuth and Che with DevWorkspace engine …
xbaran4 Jan 25, 2022
14da220
fix: fix vale errors and warnings on the master branch (#2219)
themr0c Jan 31, 2022
07d8186
fix: avoid multiple includes (#2220)
themr0c Jan 31, 2022
7c8dcc3
fix: duplicate include (#2221)
themr0c Feb 1, 2022
b2f6b43
fix: duplicate include (#2223)
themr0c Feb 1, 2022
cfeec2c
fix: metadata (#2226)
themr0c Feb 4, 2022
1118d9d
chore: remove release workflows from the master branch, we should rat…
themr0c Feb 7, 2022
2ebf39d
fix: attribute in xref
themr0c Feb 7, 2022
bd245de
fix: id
themr0c Feb 7, 2022
c0f8048
fix: file name mismatch
themr0c Feb 7, 2022
5ab7655
fix: broken link
themr0c Feb 24, 2022
3ab4340
docs: set telemetry backend-base version to 0.0.32 (#2230)
dkwon17 Mar 14, 2022
0fff7df
docs: Administration guide outline changes for devworkspace only rele…
themr0c Mar 18, 2022
bf88caf
fix: all xref pointing to real page name rather than page-aliases. (#…
themr0c Mar 21, 2022
5f43bb5
docs: Installation guide outline changes for devworkspace only releas…
themr0c Mar 21, 2022
fcdfd0c
docs: User guide outline changes for devworkspace only release (#2234)
themr0c Mar 22, 2022
f45be2f
docs: Contributor guide and extensions: remove content in master bran…
themr0c Mar 22, 2022
6202e60
docs: Updating hosted-che guide (#2236)
ibuziuk Mar 23, 2022
b06ea33
chore: merge installation guide into administration guide for master …
themr0c Mar 23, 2022
24cf06c
docs: creating a devworkspace telemetry plug-in (#2231)
dkwon17 Mar 23, 2022
9cb7b3b
fix: replace end-user by user in the content (#2240)
themr0c Mar 23, 2022
770e65d
docs: changing prod-url value in antora.yml (#2241)
themr0c Mar 23, 2022
8575e76
Update antora.yml
themr0c Mar 24, 2022
7f89255
chore: pages include modules content (#2245)
themr0c Mar 25, 2022
044d2f2
fix: fix metadata for conversion to plain AsciiDoc (#2247)
themr0c Mar 25, 2022
c0a279e
chore: refresh CONTRIBUTING, detect unused content (#2251)
themr0c Mar 29, 2022
1eec2bd
docs: move telemetry docs to Administration Guide (#2246)
dkwon17 Mar 29, 2022
40e904a
docs: Benefits of reviewing pull and merge requests in Eclipse Che (#…
themr0c Mar 29, 2022
0954d8c
chore: remove references to installation guide, unless in page-aliase…
themr0c Mar 29, 2022
949a492
fix: remove parent-context-of-telemetry-overview (#2254)
themr0c Mar 29, 2022
ba87c6d
fix: typo (#2255)
themr0c Mar 29, 2022
a8e6552
fix: duplicate page aliases (#2256)
themr0c Mar 29, 2022
e165301
fix: typo (#2257)
themr0c Mar 29, 2022
69df2d9
fix: incompatible attribute in id (#2259)
themr0c Mar 29, 2022
bc21b79
fix: incompatible attribute in id (take 2) (#2261)
themr0c Mar 29, 2022
ca2e3fb
fix: typo (#2262)
themr0c Mar 29, 2022
81dfdfc
fix: broken AsciiDoc formatting (#2264)
themr0c Mar 29, 2022
ec512ca
fix: use a lmocal image for the content (downstream requirement) (#2266)
themr0c Mar 30, 2022
68f1597
fix: use a local image for the content (downstream requirement) (#2267)
themr0c Mar 30, 2022
81118eb
docs: Adding 'Integrating with Kubernetes' user guide (#2250)
ibuziuk Mar 31, 2022
541ef42
docs: Administration guide: caching images for faster workspace start…
ibuziuk Mar 31, 2022
a9a5837
fix: antora-to-plain-asciidoc: exit on error, run at build time, fixi…
themr0c Apr 1, 2022
cd9f522
fix: typo on metadata (#2273)
themr0c Apr 1, 2022
6438455
docs: Administration guide - Calculating Che resource requirements (#…
ibuziuk Apr 5, 2022
0ebec1a
docs: applying the suggestion (#2277)
ibuziuk Apr 5, 2022
b5d4c98
docs: update telemetry overview and Woopra plug-in docs to be devwork…
dkwon17 Apr 5, 2022
2494861
fix: devworkspace operator metrics docs (#2276)
dkwon17 Apr 6, 2022
abcab3f
docs: Update docs on collecting logs using chectl (#2263)
amisevsk Apr 7, 2022
f8447a0
feat: Provides 'Adding a Visual Studio Code Extension' module (#2265)
benoitf Apr 7, 2022
f14c1fc
docs: Administration guide: Removing user data (#2278)
ibuziuk Apr 8, 2022
59f7e90
Update procedure for Che v7.41 and earlier (#2269)
l0rd Apr 11, 2022
6e492dd
fix: docs.github.com new URLs, mitigation for 403 (#2282)
themr0c Apr 12, 2022
e0c96fd
docs: accessing private Git repos (#2271)
max-cx Apr 13, 2022
bf67767
docs: user onboarding, starting a new workspace, URL parameters (#2252)
max-cx Apr 13, 2022
a571a94
docs: Installation guide supported platforms (#2284)
ibuziuk Apr 14, 2022
70441f1
fix: ifeval (#2287)
max-cx Apr 14, 2022
c360b53
fix: prefer attributes to ifeval directives (#2289)
themr0c Apr 15, 2022
a97e9ae
fix: use local contribute image (#2290)
themr0c Apr 15, 2022
495fd6c
fix: use the imagedir attribute for links to images (#2291)
themr0c Apr 15, 2022
557e0fd
fix: use examples for portability of using CLI management tool proced…
themr0c Apr 15, 2022
7b4738d
chore: added content type (#2293)
swatikarmarkar Apr 19, 2022
55cf568
fix: change git credential mounting docs to be devworkspace-specific
dkwon17 Mar 31, 2022
08a135a
Fix PR feedback
dkwon17 Apr 6, 2022
fa1f4cf
Update modules/end-user-guide/pages/git-credential-store.adoc
dkwon17 Apr 11, 2022
7ac4976
Update modules/end-user-guide/pages/git-credential-store.adoc
dkwon17 Apr 11, 2022
f447646
Update modules/end-user-guide/pages/git-credential-store.adoc
dkwon17 Apr 11, 2022
a25e77f
Update modules/end-user-guide/pages/git-credential-store.adoc
dkwon17 Apr 11, 2022
39bacfe
Update modules/end-user-guide/pages/git-credential-store.adoc
dkwon17 Apr 11, 2022
66d9f92
Fix PR feedback
dkwon17 Apr 12, 2022
946f4ba
Update modules/end-user-guide/pages/git-credential-store.adoc
dkwon17 Apr 13, 2022
2431e7f
Update modules/end-user-guide/pages/git-credential-store.adoc
dkwon17 Apr 13, 2022
1b674bd
Update modules/end-user-guide/pages/git-credential-store.adoc
dkwon17 Apr 13, 2022
0ad244e
Update modules/end-user-guide/pages/git-credential-store.adoc
dkwon17 Apr 13, 2022
58dba82
Update modules/end-user-guide/pages/git-credential-store.adoc
dkwon17 Apr 13, 2022
3789652
Re add mount-path details
dkwon17 Apr 13, 2022
b5b4604
Update modules/end-user-guide/pages/git-credential-store.adoc
dkwon17 Apr 14, 2022
a66cd7a
Update modules/end-user-guide/pages/git-credential-store.adoc
dkwon17 Apr 14, 2022
91a1307
Update modules/end-user-guide/pages/git-credential-store.adoc
dkwon17 Apr 14, 2022
93363de
Update modules/end-user-guide/pages/git-credential-store.adoc
dkwon17 Apr 14, 2022
f104519
Update modules/end-user-guide/pages/git-credential-store.adoc
dkwon17 Apr 14, 2022
059630a
Update modules/end-user-guide/pages/git-credential-store.adoc
dkwon17 Apr 14, 2022
c2a891a
Remove additional resources, change alignment
dkwon17 Apr 14, 2022
569ad1a
Update modules/end-user-guide/pages/git-credential-store.adoc
dkwon17 Apr 19, 2022
205a713
Update modules/end-user-guide/pages/git-credential-store.adoc
dkwon17 Apr 19, 2022
e453d11
Update modules/end-user-guide/pages/git-credential-store.adoc
dkwon17 Apr 19, 2022
714038c
Remove brew coreutils link, remove comma
dkwon17 Apr 19, 2022
e7ac3f5
Remove bullet points
dkwon17 Apr 19, 2022
f6b9895
Add :
dkwon17 Apr 19, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
70 changes: 38 additions & 32 deletions .github/workflows/build-and-validate-on-pr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@
#

# Name is reused in `publish-netlify.yml`
name: "Build and validate PR"
name: "Build and validate pull request"

on:
- pull_request

jobs:
build:
name: link checker # This job name is set as mandatory in the GitHub configuration.
name: "Build and validate pull request"
runs-on: ubuntu-20.04
container: "quay.io/eclipse/che-docs:latest"
steps:
Expand All @@ -24,50 +24,56 @@ jobs:
with:
fetch-depth: 0 # Necessary for git diff in vale step

- name: Build using antora # and fail on warning
id: antora-build
run: CI=true antora generate antora-playbook-for-development.yml --stacktrace 2>&1 | (tee | grep WARNING && exit 42 || exit 0)
# Cache for Antora UI and Htmltest.
# See: https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows
# Htmltest accepts 2 weeks old cache for the status code of checked external URLs
# See: https://github.com/wjdp/htmltest
# Refresh the cache every week to avoid a stale cache for htmltest
# See: https://github.com/actions/cache
# See: http://man7.org/linux/man-pages/man1/date.1.html
- name: Get Date
id: get-date
run: |
echo "::set-output name=yearweek::$(/bin/date -u "+%Y%U")"
shell: bash

- name: Upload artifact doc-content
uses: actions/upload-artifact@v2
- name: Restore cache
uses: actions/cache@v2
env:
cache-name: cache
with:
name: doc-content
path: build/site
path: .cache
key: ${{ steps.get-date.outputs.yearweek }}

- name: Build using antora # and fail on warning
id: antora-build
run: CI=true antora generate antora-playbook-for-development.yml --stacktrace --log-failure-level=warn

- name: Store PR info for publish-netlify
- name: Store pull request details for publish-netlify
run: |
echo "${{ github.event.number }}" > PR_NUMBER
echo "${{ github.event.pull_request.head.sha }}" > PR_SHA

- name: Upload artifact pull-request-number for publish-netlify
uses: actions/upload-artifact@v2
with:
name: pull-request-number
path: PR_NUMBER

- name: Upload artifact pull-request-sha for publish-netlify
- name: Upload artifact doc-content
uses: actions/upload-artifact@v2
with:
name: pull-request-sha
path: PR_SHA

- name: Cache htmltest status code of checked external URLs # See: https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows
uses: actions/cache@v2
env:
cache-name: cache-htmltest
with:
key: refcache.json
path: .cache/htmltest
name: doc-content
path: |
build/site
PR_NUMBER
PR_SHA

- name: Validate links using htmltest
id: validate-links
run: htmltest

- name: Report Unused Images
run: tools/detect-unused-images.sh
- name: Report unused content
run: tools/detect-unused-content.sh

- name: Validate language on files added or modified
run: tools/validate_language_changes.sh
run: |
tools/get_vale_styles.sh
tools/validate_language_changes.sh

- name: Count Vale infringements
run: tools/count_vale_errors.sh
- name: Validate conversion to plain asciidoc
run: tools/antora-to-plain-asciidoc.sh
77 changes: 32 additions & 45 deletions .github/workflows/build-and-validate-on-push.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@

name: Build and validate
on:
- push
push:
branches:
- main
- master
jobs:
build:
name: Build and validate
Expand All @@ -24,60 +27,44 @@ jobs:
with:
fetch-depth: 0

# Cache for Antora UI and Htmltest.
# See: https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows
# Htmltest accepts 2 weeks old cache for the status code of checked external URLs
# See: https://github.com/wjdp/htmltest
# Refresh the cache every week to avoid a stale cache for htmltest
# See: https://github.com/actions/cache
# See: http://man7.org/linux/man-pages/man1/date.1.html
- name: Get Date
id: get-date
run: |
echo "::set-output name=yearweek::$(/bin/date -u "+%Y%U")"
shell: bash
- name: Restore cache
uses: actions/cache@v2
env:
cache-name: cache
with:
path: .cache
key: ${{ steps.get-date.outputs.yearweek }}

- name: Build using antora
id: antora-build
run: CI=true antora generate antora-playbook-for-development.yml --stacktrace
run: CI=true antora generate antora-playbook-for-development.yml --stacktrace --log-failure-level=warn

- name: Upload artifact
- name: Upload artifact doc-content
uses: actions/upload-artifact@v2
with:
name: doc-content
path: build/site

# htmltest:
# name: link checker # This name is set as mandatory in the GitHub configuration.
# runs-on: ubuntu-20.04
# container: "quay.io/eclipse/che-docs:latest"
# needs: build
# steps:
# - name: Checkout code
# uses: actions/checkout@v2

- name: Cache htmltest status code of checked external URLs # See: https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows
uses: actions/cache@v2
env:
cache-name: cache-htmltest
with:
key: refcache.json
path: .cache/htmltest

# - name: Download artifacts
# uses: actions/download-artifact@v2
# with:
# name: doc-content

- name: Validate links using htmltest
id: validate-links
run: htmltest

# unusedimages:
# name: Report unused images
# runs-on: ubuntu-20.04
# steps:
# - name: Checkout code
# uses: actions/checkout@v2

- name: Report Unused Images
run: tools/detect-unused-images.sh
- name: Report unused content
run: tools/detect-unused-content.sh

# vale-all-content:
# name: Validate style on all content on push
# runs-on: ubuntu-20.04
# container: "quay.io/eclipse/che-docs:latest"
# steps:
# - name: Checkout code
# uses: actions/checkout@v2
# with:
# fetch-depth: 0
- name: Count Vale infringements
run: tools/count_vale_errors.sh
- name: Count Vale alerts
run: |
tools/get_vale_styles.sh
tools/count_vale_errors.sh
24 changes: 24 additions & 0 deletions .github/workflows/call-publication-builder.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
#
# Copyright (c) 2020 Red Hat, Inc.
# This program and the accompanying materials are made
# available under the terms of the Eclipse Public License 2.0
# which is available at https://www.eclipse.org/legal/epl-2.0/
#
# SPDX-License-Identifier: EPL-2.0
#

name: "Call publication builder"

on:
push:
branches:
- "7.*.x"
- main
- master

jobs:
call-publication-builder:
name: "Call publication builder"
uses: eclipse/che-docs/.github/workflows/publication-builder.yaml@publication-builder
secrets:
CHE_BOT_GITHUB_TOKEN: ${{ secrets.CHE_BOT_GITHUB_TOKEN }}
37 changes: 0 additions & 37 deletions .github/workflows/che-variables-update.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/publish-netlify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ name: Publish doc-content using netlify
on:
workflow_run:
workflows:
- "Build and validate PR"
- "Build and validate pull request"
types:
- completed

Expand Down
26 changes: 26 additions & 0 deletions .github/workflows/pull-request-drafts.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
#
# Copyright (c) 2021 Red Hat, Inc.
# This program and the accompanying materials are made
# available under the terms of the Eclipse Public License 2.0
# which is available at https://www.eclipse.org/legal/epl-2.0/
#
# SPDX-License-Identifier: EPL-2.0
#
# Automate pull requests triage

name: Pull request opened

on:
pull_request_target:
types:
- converted_to_draft

jobs:
automate-project-columns:
runs-on: ubuntu-latest
steps:
- uses: alex-page/github-project-automation-plus@v0.8.1
with:
project: Reviews
column: Drafts
repo-token: ${{ secrets.CHE_BOT_GITHUB_TOKEN }}
2 changes: 2 additions & 0 deletions .github/workflows/pull-request-opened.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ on:
pull_request_target:
types:
- opened
- ready_for_review
- unassigned

jobs:
automate-project-columns:
Expand Down
64 changes: 0 additions & 64 deletions .github/workflows/release.yml

This file was deleted.

4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,14 @@ vendor
# Antora
.cache
node_modules/
build/plain-asciidoc
build/site
build/site.zip
build/site-unbranded

# Keep Vale styles external
.vale/styles/

linkchecker-out.html
.ash_history
.bash_history
Expand Down
Loading