-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
491 changed files
with
57,923 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# editorconfig.org | ||
|
||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
# Leave line endings to Git: `core.autocrlf` | ||
# & `.gitattributes` text=auto normalization | ||
# end_of_line = lf | ||
indent_size = 2 | ||
indent_style = space | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
|
||
# Preserve trailing space in Markdown | ||
# > When you do want to insert a <br /> break tag using Markdown, | ||
# > you end a line with two or more spaces, then type return. | ||
|
||
[*.md, *.mdown, *.markdown] | ||
trim_trailing_whitespace = false | ||
|
||
[.git/config] | ||
# Prevent mixed indentation in Git config (Git commands insert tabs) | ||
indent_style = tab |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# List of commits to ignore during blame | ||
|
||
# Set your local config to use this file | ||
# $ git config blame.ignoreRevsFile .git-blame-ignore-revs | ||
|
||
# Format: 1 unabbreviated SHA-1 per line | ||
|
||
# Batch format & indent files 2019-11-13 | ||
530b8c28ae4d24b392c77b81ca45605cc09a8427 | ||
|
||
# Initial Prettier setup run: 2020-09-26 | ||
76c423f4b020096626d803db1afea3896033413e | ||
|
||
# Subsequent Prettier formatting commits | ||
b2d430307b1cae70e391cbc71cf7e9cdd02652e5 | ||
c734de7bcabac40513752fb0a9c4ce79869be7da | ||
b79e3346415ba66544bd7fe8439272f6e130ce3c | ||
71b3285875cb65b3bd23dc98152f03752cd6f08d | ||
|
||
# Miscellaneous other formatting commits | ||
9213e9277cf7c713607b277adc795c99a0a50332 | ||
|
||
# [1]: https://git-scm.com/docs/git-blame#Documentation/git-blame.txt---ignore-revltrevgt | ||
# [2]: https://black.readthedocs.io/en/hello-furo/guides/introducing_black_to_your_project.html#avoiding-ruining-git-blame | ||
# [3]: https://www.moxio.com/blog/43/ignoring-bulk-change-commits-with-git-blame | ||
# [4]: https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file#ignore-commits-in-the-blame-view |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# Handle line endings per <http://help.github.com/line-endings/> | ||
|
||
# Set the default behavior, in case `core.autocrlf` isn’t set | ||
# (auto-detect text files and perform LF normalization): | ||
* text=auto | ||
|
||
# Normalize text files & convert to native line endings on checkout: | ||
*.css text | ||
*.dita* text | ||
*.dtd text | ||
*.ent text | ||
*.htm text diff=html | ||
*.html text diff=html | ||
*.js text | ||
*.less text | ||
*.md text | ||
*.mod text | ||
*.properties text | ||
*.sass text | ||
*.scss text | ||
*.txt text | ||
*.xml text | ||
*.xsd text | ||
*.xsl text | ||
|
||
# Files that should always have Windows CRLF line endings on checkout: | ||
*.bat text eol=crlf | ||
*.cmd text eol=crlf | ||
|
||
# Files that should always have UNIX LF line endings on checkout: | ||
*.sh text eol=lf | ||
|
||
# These files are binary and should be left untouched: | ||
*.ico binary | ||
*.jpeg binary | ||
*.jpg binary | ||
*.png binary | ||
# Fonts | ||
*.eot binary | ||
*.otf binary | ||
*.ttf binary | ||
*.woff binary | ||
|
||
# Diff text content of Word files & similar formats as plain text: | ||
*.doc diff=astextplain | ||
*.DOC diff=astextplain | ||
*.docx diff=astextplain | ||
*.DOCX diff=astextplain | ||
*.dot diff=astextplain | ||
*.DOT diff=astextplain | ||
*.rtf diff=astextplain | ||
*.RTF diff=astextplain |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
# Contributing to the DITA-OT docs | ||
|
||
We welcome your contributions to the DITA-OT documentation. | ||
|
||
Thanks for your interest — here’s how you can help us _“write the docs.”_ | ||
|
||
## Creating an issue | ||
|
||
If you find a bug or would like to suggest a new topic for the DITA-OT docs, create an issue: | ||
|
||
1. Search [dita-ot/docs/issues][1] to ensure your issue hasn’t already been reported. | ||
2. [Create an issue][2]. If it’s a bug, provide steps to recreate the issue. | ||
3. [Send a pull request][3]. If you know how to fix the issue yourself, submit a pull request with the proposed changes. | ||
|
||
_Read on for details…_ | ||
|
||
## Submitting pull requests | ||
|
||
Good pull requests—corrections, improvements, new topics—are a great help. They should remain focused in scope and shouldn’t contain unrelated commits. | ||
|
||
Follow this process to ensure your contribution meets our expectations and increase the chances that your changes will be included: | ||
|
||
1. [Fork][4] the docs repository, clone your fork, and configure the remotes: | ||
|
||
```bash | ||
# Clone your docs fork into the current directory | ||
git clone https://github.com/<your-username>/docs | ||
|
||
# Navigate to the newly cloned directory | ||
cd docs | ||
|
||
# Assign the original repo to a remote called "upstream" | ||
git remote add upstream https://github.com/dita-ot/docs | ||
``` | ||
|
||
2. If you cloned a while ago, get the latest changes from upstream: | ||
|
||
```bash | ||
git checkout develop | ||
git pull upstream develop | ||
``` | ||
|
||
3. Create a new feature branch _(off the upstream project’s `develop` branch)_ for your new feature, change, or fix: | ||
|
||
```bash | ||
git checkout -b your-new-branch | ||
``` | ||
|
||
4. Commit your changes in logical chunks. | ||
|
||
Please be sure to follow the [coding guidelines][5] and [best practices][6] outlined in the docs project wiki: | ||
|
||
- [Test before committing][7] | ||
- [Commit related changes][8] | ||
- [Commit often][9] | ||
- [Write good commit messages][10] | ||
|
||
Use Git’s [interactive rebase][11] feature to tidy up your commits, if necessary, before making them public. | ||
|
||
5. Indicate that you agree to the terms of the Apache License Version 2.0 by "[signing off][12]" your contribution with `git commit -s`. | ||
|
||
This adds a line with your name and e-mail address to your Git commit message: | ||
|
||
```bash | ||
Signed-off-by: Jane Doe <[email protected]> | ||
``` | ||
|
||
6. Locally merge _(or rebase)_ the upstream `develop` branch into your feature branch: | ||
|
||
```bash | ||
git pull [--rebase] upstream develop | ||
``` | ||
|
||
7. Push your feature branch up to your fork: | ||
|
||
```bash | ||
git push origin your-new-branch | ||
``` | ||
|
||
8. [Open a pull request][3] with a clear title and description. | ||
|
||
**Pro tip:** If there’s no corresponding issue for the changes you're proposing, there’s no need to create one first. | ||
You can describe the problem and provide the solution all in one step. | ||
_(Under the hood, pull requests are just a special type of issue.)_ | ||
|
||
[1]: https://github.com/dita-ot/docs/issues | ||
[2]: https://github.com/dita-ot/docs/issues/new | ||
[3]: https://help.github.com/articles/using-pull-requests/ | ||
[4]: https://help.github.com/articles/fork-a-repo/ | ||
[5]: https://github.com/dita-ot/docs/wiki/Coding-guidelines | ||
[6]: https://github.com/dita-ot/docs/wiki/Git-workflow#best-practices | ||
[7]: https://github.com/dita-ot/docs/wiki/Git-workflow#test-before-committing | ||
[8]: https://github.com/dita-ot/docs/wiki/Git-workflow#commit-related-changes | ||
[9]: https://github.com/dita-ot/docs/wiki/Git-workflow#commit-often | ||
[10]: https://github.com/dita-ot/docs/wiki/Git-workflow#writing-good-commit-messages | ||
[11]: https://help.github.com/articles/interactive-rebase | ||
[12]: https://www.dita-ot.org/DCO |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
name: 'Render website' | ||
description: 'Render dita-ot/docs into dita-ot/website' | ||
inputs: | ||
WEBSITE_PLUGIN_BRANCH: | ||
description: 'Website plug-in ref' | ||
default: 'master' | ||
DITA_OT_VERSION: | ||
description: 'DITA-OT version used for rendering' | ||
default: '4.2.3' | ||
runs: | ||
using: 'composite' | ||
steps: | ||
- name: Set up JDK 17 | ||
uses: actions/setup-java@v4 | ||
with: | ||
distribution: temurin | ||
java-version: 17 | ||
cache: 'gradle' | ||
- name: Set Node.js version 12.x | ||
uses: actions/setup-node@v4 | ||
with: | ||
node-version: '20.x' | ||
cache: 'npm' | ||
- name: Set up Ruby | ||
uses: ruby/setup-ruby@v1 | ||
with: | ||
ruby-version: 2.6 | ||
- name: Download website plug-in | ||
shell: bash | ||
run: | | ||
curl -sL https://github.com/dita-ot/org.dita-ot.html/archive/refs/heads/${{ inputs.WEBSITE_PLUGIN_BRANCH }}.zip -o org.dita-ot.html.zip | ||
- name: Cache stable DITA-OT | ||
uses: actions/cache@v2 | ||
with: | ||
path: dita-ot-${{ inputs.DITA_OT_VERSION }} | ||
key: ${{ runner.os }}-dita-ot-${{ inputs.DITA_OT_VERSION }} | ||
- name: Download stable DITA-OT | ||
shell: bash | ||
run: | | ||
if [ ! -d "dita-ot-${{ inputs.DITA_OT_VERSION }}" ]; then | ||
curl -sL https://github.com/dita-ot/dita-ot/releases/download/${{ inputs.DITA_OT_VERSION }}/dita-ot-${{ inputs.DITA_OT_VERSION }}.zip -o dita-ot-${{ inputs.DITA_OT_VERSION }}.zip | ||
unzip dita-ot-${{ inputs.DITA_OT_VERSION }}.zip | ||
else | ||
echo "Use cached dita-ot-${{ inputs.DITA_OT_VERSION }}" | ||
fi | ||
dita-ot-${{ inputs.DITA_OT_VERSION }}/bin/dita install org.dita-ot.html.zip --force -v | ||
- name: Get develop DITA-OT ETag | ||
shell: bash | ||
run: | | ||
curl -sI https://s3-eu-west-1.amazonaws.com/dita-ot/dita-ot-develop.zip | grep -F ETag | cut -d'"' -f 2 > dita-ot-develop.etag | ||
- name: Cache develop DITA-OT | ||
uses: actions/cache@v2 | ||
with: | ||
path: dita-ot-develop | ||
key: ${{ runner.os }}-dita-ot-develop-${{ hashFiles('dita-ot-develop.etag') }} | ||
restore-keys: | | ||
${{ runner.os }}-dita-ot-develop- | ||
- name: Download develop DITA-OT | ||
shell: bash | ||
run: | | ||
if [ ! -d "dita-ot-develop" ]; then | ||
curl -sL https://s3-eu-west-1.amazonaws.com/dita-ot/dita-ot-develop.zip -o dita-ot-develop.zip | ||
unzip dita-ot-develop.zip -d dita-ot-develop | ||
else | ||
echo "Use cached dita-ot-develop" | ||
fi | ||
echo "DITA_OT_DEV=$(find dita-ot-develop -name 'dita-ot-*@*' -type d | head -1)" >> $GITHUB_ENV | ||
- name: Run DITA-OT | ||
shell: bash | ||
run: | | ||
./gradlew site \ | ||
-PditaHome=${{ github.workspace }}/dita-ot-${{ inputs.DITA_OT_VERSION }} \ | ||
-PoutputDir=${{ github.workspace }}/website/dev \ | ||
-PditaHomeSrc=${{ env.DITA_OT_DEV }} \ | ||
--info --stacktrace --no-daemon |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
version: 2 | ||
updates: | ||
- package-ecosystem: npm | ||
directory: '/' | ||
schedule: | ||
interval: monthly | ||
time: '12:00' | ||
timezone: 'Europe/Berlin' | ||
open-pull-requests-limit: 10 | ||
- package-ecosystem: github-actions | ||
directory: '/' | ||
schedule: | ||
interval: monthly | ||
time: '12:00' | ||
timezone: 'Europe/Berlin' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# Configuration for probot-no-response - https://github.com/probot/no-response | ||
|
||
# Number of days of inactivity before an Issue is closed for lack of response | ||
daysUntilClose: 30 | ||
|
||
# Label requiring a response | ||
responseRequiredLabel: need-more-info | ||
|
||
# Comment to post when closing an Issue for lack of response. Set to `false` to disable | ||
closeComment: > | ||
This issue has been automatically closed because there has been no response | ||
to our request for more information from the original author. With only the | ||
information that is currently in the issue, we don’t have enough to go on. | ||
Please reach out if you have any updates that would allow us to proceed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# Configuration for probot-stale - https://github.com/probot/stale | ||
|
||
# Number of days of inactivity before an Issue or Pull Request becomes stale | ||
daysUntilStale: 730 | ||
|
||
# Number of days of inactivity before an Issue or Pull Request with the stale label is closed. | ||
# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale. | ||
daysUntilClose: 14 | ||
|
||
# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable | ||
exemptLabels: | ||
- pinned | ||
- security | ||
|
||
# Set to true to ignore issues in a project (defaults to false) | ||
exemptProjects: true | ||
|
||
# Set to true to ignore issues in a milestone (defaults to false) | ||
exemptMilestones: false | ||
|
||
# Label to use when marking as stale | ||
staleLabel: stale | ||
|
||
# Comment to post when marking as stale. Set to `false` to disable | ||
markComment: > | ||
This issue has been automatically marked as stale because it has not been updated recently. | ||
It will be closed soon if no further activity occurs. Thank you for your contributions. | ||
# Comment to post when removing the stale label. | ||
# unmarkComment: > | ||
# Your comment here. | ||
|
||
# Comment to post when closing a stale Issue or Pull Request. | ||
# closeComment: > | ||
# Your comment here. | ||
|
||
# Limit the number of actions per hour, from 1-30. Default is 30 | ||
limitPerRun: 30 | ||
# Limit to only `issues` or `pulls` | ||
# only: issues | ||
|
||
# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls': | ||
# pulls: | ||
# daysUntilStale: 30 | ||
# markComment: > | ||
# This pull request has been automatically marked as stale because it has not had | ||
# recent activity. It will be closed if no further activity occurs. Thank you | ||
# for your contributions. | ||
|
||
# issues: | ||
# exemptLabels: | ||
# - confirmed |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
#!/usr/bin/env ruby | ||
|
||
changed = `git diff --name-only`.split("\n") | ||
changed.each do |file| | ||
diff = `git diff -U0 #{file}`.split("\n") | ||
if (diff.length == 7 && diff[5].start_with?("-commit:") && diff[6].start_with?("+commit:")) | ||
puts "Reset #{file}" | ||
`git checkout -- #{file}` | ||
end | ||
end |
Oops, something went wrong.