Skip to content

Commit

Permalink
Merge branch 'release/2.3'
Browse files Browse the repository at this point in the history
* release/2.3: (250 commits)
  Add section on documentation updates
  Update contributor list
  Implement review feedback
  Update Gradle build per @eerohele feedback
  Promote release highlights in short description
  Extend descriptions for recently resolved issues
  Simplify deprecated variable list
  Add recently resolved issues to 2.3 Release Notes
  Use 2-digit 'maintenance-version' key for 2.3
  Remove obsolete “Tested tools” topic (Closes #59)
  Add info on switched order of 'chunk' & 'move-meta'
  Edit additional issue descriptions, highlight i18n
  Draft info on Release Highlights
  Add info on BEM-style CSS classes
  Add initial info on migrating to v2.3 (Fixes #29)
  Format & indent per project conventions
  Split Migration section into submap
  Implement additional review feedback
  First draft of issue descriptions (#100)
  Refactor nested <simpletable> in <dl>
  ...
  • Loading branch information
infotexture committed May 29, 2016
2 parents aade874 + 9298fef commit 2f3fd37
Show file tree
Hide file tree
Showing 219 changed files with 8,545 additions and 2,649 deletions.
20 changes: 20 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# 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
31 changes: 30 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,37 @@
## Directories generated during builds
out/
temp/
build/
logs/
samples/properties/template.properties

## Autogenerated files created by the build process
platform.ditaval
DITA-messages.xml
parameters/_all-parameters.dita
extension-points/all-extension-points.dita
extension-points/extension-point-com.sophos.tocjs.dita
extension-points/extension-point-org.dita-ot.html.dita
extension-points/extension-point-org.dita.base.dita
extension-points/extension-point-org.dita.docbook.dita
extension-points/extension-point-org.dita.eclipsecontent.dita
extension-points/extension-point-org.dita.eclipsehelp.dita
extension-points/extension-point-org.dita.html5.dita
extension-points/extension-point-org.dita.htmlhelp.dita
extension-points/extension-point-org.dita.javahelp.dita
extension-points/extension-point-org.dita.odt.dita
extension-points/extension-point-org.dita.pdf2.axf.dita
extension-points/extension-point-org.dita.pdf2.dita
extension-points/extension-point-org.dita.pdf2.fop.dita
extension-points/extension-point-org.dita.pdf2.xep.dita
extension-points/extension-point-org.dita.specialization.dita11.dita
extension-points/extension-point-org.dita.specialization.dita132.dita
extension-points/extension-point-org.dita.specialization.eclipsemap.dita
extension-points/extension-point-org.dita.troff.dita
extension-points/extension-point-org.dita.wordrtf.dita
extension-points/extension-point-org.dita.xhtml.dita
extension-points/extension-point-org.oasis-open.dita.v1_2.dita
extension-points/extension-point-org.oasis-open.dita.v1_3.dita
parameters/all-parameters.dita
parameters/parameters-base-html.dita
parameters/parameters-base.dita
parameters/parameters-common-html.dita
Expand All @@ -26,3 +52,6 @@ parameters/parameters-tocjs.dita
parameters/parameters-troff.dita
parameters/parameters-wordrtf.dita
parameters/parameters-xhtml.dita

# Gradle
.gradle/
13 changes: 13 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
sudo: false
language: java
jdk:
- oraclejdk7
env:
global:
- DITA_OT_VERSION=2.2.5
install:
- ".travis/install.sh"
script:
- ".travis/publish.sh"
after_success:
- ".travis/deploy.sh"
10 changes: 10 additions & 0 deletions .travis/clean.rb
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
28 changes: 28 additions & 0 deletions .travis/deploy.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
#!/usr/bin/env bash

# CI deployment script (runs after publish script)

if [ "$TRAVIS_PULL_REQUEST" = "false" -a "$TRAVIS_BRANCH" = "develop" ]; then
export SSH_DIR=$PWD/.travis
export SITE_DIR=$PWD/dita-ot.github.io

# install SSH key
eval "$(ssh-agent -s)"
chmod 600 $PWD/.travis/ditaotbot_rsa
ssh-add $PWD/.travis/ditaotbot_rsa

cd $SITE_DIR

# Reset files where only commit metadata has changed
ruby ../.travis/clean.rb
# commit site
git config user.email "ditaotbot@gmail.com"
git config user.name "DITA-OT Bot"
# Add (stage) all untracked & modified files and remove all missing files
git add --all
# Commit generated site output
git commit -a -m "Deploy dita-ot/docs@${TRAVIS_COMMIT:0:7} to 'dev' docs"
# push
git remote set-url origin git@github.com:dita-ot/dita-ot.github.io.git
git push -v origin master
fi
Binary file added .travis/ditaotbot_rsa.enc
Binary file not shown.
27 changes: 27 additions & 0 deletions .travis/install.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
#!/usr/bin/env sh

# CI install script
echo "TRAVIS_PULL_REQUEST=$TRAVIS_PULL_REQUEST"
echo "TRAVIS_BRANCH=$TRAVIS_BRANCH"

if [ "$TRAVIS_PULL_REQUEST" = "false" -a "$TRAVIS_BRANCH" = "develop" ]; then
openssl aes-256-cbc -K $encrypted_324699cc92df_key -iv $encrypted_324699cc92df_iv -in .travis/ditaotbot_rsa.enc -out .travis/ditaotbot_rsa -d
fi

# download stable dita-ot
curl -L https://github.com/dita-ot/dita-ot/releases/download/$DITA_OT_VERSION/dita-ot-$DITA_OT_VERSION.zip -o dita-ot-$DITA_OT_VERSION.zip
unzip dita-ot-$DITA_OT_VERSION.zip
export DITA_HOME=$PWD/dita-ot-$DITA_OT_VERSION

# download develop dita-ot
curl -L https://s3-eu-west-1.amazonaws.com/dita-ot/dita-ot-develop.zip -o dita-ot-develop.zip
unzip dita-ot-develop.zip

#if [ "$TRAVIS_PULL_REQUEST" = "false" -a "$TRAVIS_BRANCH" = "develop" ]; then
# install site plugin
curl -L https://github.com/dita-ot/org.dita-ot.html/archive/master.zip -o org.dita-ot.html.zip
$DITA_HOME/bin/dita -install org.dita-ot.html.zip -v

# clone site
git clone -b master https://github.com/dita-ot/dita-ot.github.io.git
#fi
16 changes: 16 additions & 0 deletions .travis/publish.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#!/usr/bin/env sh

# CI publish script

export DITA_HOME=$PWD/dita-ot-$DITA_OT_VERSION
export DITA_OT_DEV=$(find $PWD -name 'dita-ot-*+*' -type d | head -1)
export SITE_DIR=$PWD/dita-ot.github.io

#if [ "$TRAVIS_PULL_REQUEST" = "false" -a "$TRAVIS_BRANCH" = "develop" ]; then
# Remove target output directory before generating new output
rm -rf "$SITE_DIR/dev"
# Re-create /dev folder & generate site output there
./gradlew -b site.gradle -Ddita.home=$DITA_HOME -Doutput.dir=$SITE_DIR/dev -PditaHomeSrc=$DITA_OT_DEV --info --stacktrace --no-daemon
#else
# ./gradlew -Ddita.home=$DITA_HOME html --info --stacktrace --no-daemon
#fi
95 changes: 70 additions & 25 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,86 @@
# Contribution Guidelines
# Contributing to the DITA-OT docs

We welcome contributions to the DITA-OT documentation.
We welcome your contributions to the DITA-OT documentation.

## Create an Issue
Thanks for your interest — here's how you can help us _“write the docs.”_

If you find a bug — _and you don’t know how to fix it_, [create an issue][1] to request changes.
## Creating an issue

Before you do that, [review the open issues][2] to make sure it hasn't already been reported.
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.

_or — even better:_
_Read on for details…_

## Create a Pull Request
## Submitting pull requests

If you know how to fix the issue yourself, that's great! Here's what to do:
Good pull requests—corrections, improvements, new topics—are a great help. They should remain focused in scope and shouldn't contain unrelated commits.

1. [Fork the repository][3],
2. [Create a new branch][4],
3. Make your changes on the new branch, and
4. [Send a pull request][5].
Follow this process to ensure your contribution meets our expectations and increase the chances that your changes will be included:

### Always create a branch for your changes
1. [Fork][4] the docs repository, clone your fork, and configure the remotes:

The DITA-OT project uses the [Git Flow][6] branching strategy.
```bash
# Clone your docs fork into the current directory
git clone https://github.com/<your-username>/docs

In this model, change requests are tracked in feature branches that are created by branching off of the main development baseline in the `develop` branch. This makes it easier to keep track of related changes and merge them back into the development stream later. To find out more about how this works, see the [Gitflow Workflow][7] tutorial.
# Navigate to the newly cloned directory
cd docs

To send a pull request, create a feature branch in your fork with a name like `feature/my-changes`, make your changes on that branch in your fork and issue the pull request from there.
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/dita-ot/docs
```

For more information, see [Contributing to Open Source on GitHub][8].
2. If you cloned a while ago, get the latest changes from upstream:

```bash
git checkout develop
git pull upstream develop
```

[1]: https://github.com/dita-ot/docs/issues/new
[2]: https://github.com/dita-ot/docs/issues
[3]: https://help.github.com/articles/fork-a-repo/
[4]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
[5]: https://help.github.com/articles/using-pull-requests/
[6]: http://nvie.com/posts/a-successful-git-branching-model/
[7]: https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow
[8]: https://guides.github.com/activities/contributing-to-open-source/
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:
* [Commit related changes][7]
* [Commit often][8]
* [Write good commit messages][9]
Use Git's [interactive rebase][10] feature to tidy up your commits, if necessary, before making them public.

5. Locally merge _(or rebase)_ the upstream `develop` branch into your feature branch:

```bash
git pull [--rebase] upstream develop
```

6. Push your feature branch up to your fork:

```bash
git push origin your-new-branch
```

7. [Open a pull request][11] 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#commit-related-changes
[8]: https://github.com/dita-ot/docs/wiki/Git-workflow#commit-related-changes
[9]: https://github.com/dita-ot/docs/wiki/Git-workflow#writing-good-commit-messages
[10]: https://help.github.com/articles/interactive-rebase
[11]: https://help.github.com/articles/using-pull-requests/
2 changes: 1 addition & 1 deletion DITA-OT_docs.xpr
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="17.1">
<meta>
<filters directoryPatterns="out, temp" filePatterns="Icon.png" positiveFilePatterns="" showHiddenFiles="false"/>
<filters directoryPatterns=".gradle, build, out, temp" filePatterns="Icon.png" positiveFilePatterns="" showHiddenFiles="false"/>
<options>
<serialized version="17.1" xml:space="preserve">
<serializableOrderedMap>
Expand Down
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,13 @@ This repository tracks the source files for the [DITA Open Toolkit documentation

We welcome contributions to the DITA-OT documentation. Please review the [guidelines for contributing][2] to this repository before creating issues or opening pull requests.

To increase the chances of your changes being approved, please be sure to follow the [coding guidelines][3] and [best practices][4] outlined in the docs project wiki:

## Building Output
* [Commit related changes][5]
* [Commit often][6]
* [Write good commit messages][7]

## Building output

To generate additional topics and build the documentation output, run the Ant build script from the root level of the `docs` repository and specify the target output format.

Expand All @@ -31,3 +36,8 @@ or:

[1]: http://www.dita-ot.org/dev/
[2]: CONTRIBUTING.md
[3]: https://github.com/dita-ot/docs/wiki/Coding-guidelines
[4]: https://github.com/dita-ot/docs/wiki/Git-workflow#best-practices
[5]: https://github.com/dita-ot/docs/wiki/Git-workflow#commit-related-changes
[6]: https://github.com/dita-ot/docs/wiki/Git-workflow#commit-related-changes
[7]: https://github.com/dita-ot/docs/wiki/Git-workflow#writing-good-commit-messages
38 changes: 38 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
plugins {
id 'com.github.eerohele.dita-ot-gradle' version '0.3.1'
}

ditaOt.dir System.getProperty('dita.home', '../')

import com.github.eerohele.AntBuilderAssistant
def antBuilder = AntBuilderAssistant.getAntBuilder(project)

task pdf << {
antBuilder.execute {
ant(antfile: 'build.xml', target: 'pdf')
}
}

task html << {
antBuilder.execute {
ant(antfile: 'build.xml', target: 'html')
}
}

task htmlhelp << {
antBuilder.execute {
ant(antfile: 'build.xml', target: 'htmlhelp')
}
}

task clean << {
antBuilder.execute {
ant(antfile: 'build.xml', target: 'clean')
}
}

task all(dependsOn: [pdf, html, htmlhelp])

task dist(dependsOn: [pdf, html])

defaultTasks 'dist'
Loading

0 comments on commit 2f3fd37

Please # to comment.