Skip to content

Creating a preview of the outline proposed #226

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.

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

Merged
merged 41 commits into from
Aug 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
52c040e
Creating a preview of the outline proposed
kinow Jul 12, 2022
20f3960
Remove unused files
kinow Jul 31, 2022
bf3adae
Add CWL logo to basic concepts
kinow Jul 31, 2022
074b0ae
Improve graphs in basic concepts
kinow Aug 1, 2022
bc07ab2
Re-use content in other sections
kinow Aug 1, 2022
9f5a00a
Move old content to new pages, and add attention notes to old pages
kinow Aug 1, 2022
843add6
Remove Steps, add notes about the issue with anchor links in included…
kinow Aug 1, 2022
c7cf1e1
Move advanced topics into its own top level section
kinow Aug 2, 2022
36063e3
Add initial content for FAQ and tutorials
kinow Aug 2, 2022
a924ade
Making comment into initial content for the HowTos page
kinow Aug 2, 2022
ae515db
Move the recommended practices to a new page under Advanced Topics (?)
kinow Aug 2, 2022
c073185
Move the remaining pages to Advanced Topics
kinow Aug 2, 2022
20c7600
Include graphviz apt package to RTD
kinow Aug 2, 2022
b219ae5
Remove the content of the out-of-date pages, change their titles to "…
kinow Aug 3, 2022
7a1a0d3
Move Miscelaneous to the HowTos page
kinow Aug 4, 2022
f885f37
Fix link
kinow Aug 4, 2022
6331e3e
Hide Operations and Requirements and Hints, still under development
kinow Aug 4, 2022
4b872ff
Add a short paragraph about core and about the advanced sections
kinow Aug 4, 2022
446a988
Remove links to old sections, correct Arvados doc link
kinow Aug 4, 2022
9016332
Add initial text for the Operations section. Link it from the basic c…
kinow Aug 8, 2022
b6b4785
Reviewing captions and code blocks
kinow Aug 9, 2022
e069109
Make best practices page a list, instead of paragraphs with leading s…
kinow Aug 9, 2022
3118a7a
Fix links
kinow Aug 9, 2022
998d276
Add numbers to sections
kinow Aug 9, 2022
d7ec895
Move the first three sections to introduction
kinow Aug 9, 2022
7209535
Rename core-concepts to essential-topics
kinow Aug 9, 2022
e8d8c55
Move YAML guide to under Essential Topics
kinow Aug 9, 2022
8203819
Make sections under Introduction separate pages
kinow Aug 9, 2022
f45cbff
Merge FAQ and How-Tos
kinow Aug 10, 2022
db22bf3
Add a Table of Contents to the FAQ/HowTos
kinow Aug 10, 2022
380c05c
Trying to simplify the Processes and Requirements 5 sections into a s…
kinow Aug 10, 2022
7e0a965
Fix broken links, thanks @mr-c for spotting this
kinow Aug 17, 2022
8854ac6
#217 add link to the main website
kinow Aug 17, 2022
5ee0f48
Move parameter references to its own section
kinow Aug 17, 2022
d8a2249
Rename scattering workflows to scattering steps
kinow Aug 17, 2022
f10f579
Move additional arguments and parameters to its own section
kinow Aug 18, 2022
ded8694
Add Style Guide to README, with note about links and about standard v…
kinow Aug 18, 2022
db5f32e
Add a Building section to the CONTRIBUTING.md file, after the part ab…
kinow Aug 18, 2022
51a497d
Add readthedocs preview message to PR, also update the docs telling u…
kinow Aug 18, 2022
b82853c
Remove old documentation (meta redirects handle it), fix links, add n…
kinow Aug 22, 2022
2cff040
Remove essential and advanced topics, merge into single topics category
kinow Aug 22, 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
  •  
  •  
  •  
20 changes: 20 additions & 0 deletions .github/workflows/documentation-links.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# https://github.com/readthedocs/actions/tree/v1/preview#how-to-use-it
name: Read the Docs Pull Request Preview
on:
pull_request_target:
types:
- opened

permissions:
pull-requests: write

jobs:
documentation-links:
runs-on: ubuntu-latest
steps:
- uses: readthedocs/actions/preview@v1
with:
project-slug: "common-workflow-languageuser-guide"
project-language: "en"
# message-template: ?
platform: "community"
2 changes: 1 addition & 1 deletion .github/workflows/gh-pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
restore-keys: |
${{ runner.os }}-pip-
- name: Install dependencies
run: python3 -m pip install -U -r ./requirements.txt
run: python3 -m pip install -U -e .[all]

- name: Build documentation
run: make html
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ _site
.RData

_build/
*.egg-info/
20 changes: 20 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
version: 2

build:
os: ubuntu-20.04
tools:
python: "3.9"
apt_packages:
- graphviz

sphinx:
configuration: src/conf.py
builder: html

python:
install:
- method: pip
path: .
extra_requirements:
- all

4 changes: 2 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ branches:
- main
- /.*/

before_script:
install:
- pip install -U pip setuptools wheel typing
- pip install cwltool cwltest html5lib
- pip install -e .[all]

script:
- make RUNNER=cwltool unittest-examples
31 changes: 0 additions & 31 deletions 01-introduction/index.md

This file was deleted.

104 changes: 0 additions & 104 deletions 02-1st-example/index.md

This file was deleted.

149 changes: 0 additions & 149 deletions 03-input/index.md

This file was deleted.

Loading