Skip to content
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

docs(index.html): add getting started section #69

Merged
merged 27 commits into from
Jun 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
6dc64fb
docs(index.html): add getting started section
marcoscaceres May 28, 2021
8ed8906
Add explicit id
marcoscaceres May 28, 2021
0c1469f
Typo
marcoscaceres May 28, 2021
5076c4f
Merge branch 'main' into getting_started
marcoscaceres May 28, 2021
03de5ff
Make a new README.md in docs
marcoscaceres May 28, 2021
d1ff762
Fixup
marcoscaceres May 28, 2021
0908499
Merge branch 'main' into getting_started
marcoscaceres May 28, 2021
c81d332
use pr-push as file name
marcoscaceres May 28, 2021
f0caf94
use auto-publish.yml
marcoscaceres May 28, 2021
d25a9c7
Update docs/README.md
marcoscaceres May 28, 2021
7fd6b4c
fixup indent
marcoscaceres May 28, 2021
edf4fe8
remove id
marcoscaceres May 28, 2021
9a70823
fix example, specify getting started example is for W3C
sidvishnoi May 31, 2021
5566bbb
nit
sidvishnoi May 31, 2021
92758f9
more nits
sidvishnoi May 31, 2021
b8fcf6d
minor fixes in fixLinks
sidvishnoi May 31, 2021
7526561
docs: improve postProcess.fixLinks
sidvishnoi May 31, 2021
aef1cfd
docs(index.html): improve fixLinks (#73)
sidvishnoi May 31, 2021
205b5b2
Merge branch 'main' into getting_started
sidvishnoi May 31, 2021
b6f006f
Merge branch 'main' into getting_started
sidvishnoi Jun 1, 2021
58ede1b
chore(.editorconfig): add indent_size=2
sidvishnoi Jun 1, 2021
ced23aa
Merge branch 'main' into getting_started
sidvishnoi Jun 1, 2021
8961936
Merge branch 'main' into getting_started
sidvishnoi Jun 1, 2021
e5a14a1
Update docs/README.md
sidvishnoi Jun 1, 2021
57b6ffa
fix fixLinks
sidvishnoi Jun 1, 2021
675b9d8
fix fixLinks final
sidvishnoi Jun 1, 2021
b439fd1
Merge branch 'main' into getting_started
sidvishnoi Jun 1, 2021
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
37 changes: 37 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## Getting started

To get started, do the following:

1. If you want to deploy to W3C /TR:
1. [Request an Echidna token][request-token] for your spec (W3C Team Members and Chairs only!).
1. [Save the token][save-token] as a "Secret" named `ECHIDNA_TOKEN` in the spec's repository's settings.
1. Create a `.github/workflows/auto-publish.yml` file at the root of the spec's repository.
1. In the `auto-publish.yml`, copy-paste and modify one of the [examples](examples.md) below that suits your needs. Most typical one:

```yml
# Inside .github/workflows/auto-publish.yml
name: Automatic Publication

on:
pull_request: {}
push:
branches: [main]

jobs:
validate-and-publish:
name: Validate and Publish to TR
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- uses: w3c/spec-prod@v2
with:
TOOLCHAIN: respec # or bikeshed
W3C_ECHIDNA_TOKEN: ${{ secrets.ECHIDNA_TOKEN }}
W3C_WG_DECISION_URL: " See Options for URLs! "
# Convert Editor's Draft to Working Draft!
W3C_BUILD_OVERRIDE: |
specStatus: WD
```

[request-token]: https://www.w3.org/Web/publications/register
[save-token]: https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository
1 change: 1 addition & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@
</li>
</ul>
</section>
<section data-include="README.md" data-include-format="markdown"></section>
<section
data-include="examples.md"
data-include-format="markdown"
Expand Down