README.md

Using oXygen Web Author for casual contributions

Access the free trial oXygen Web Author environment at https://www.oxygenxml.com/oxygen-xml-web-author/app/oxygen.html

You need a have a GitHub account.

Connect to the sample GitHub repository

1. Under Open, select Git.
2. Select Login with GitHub.
3. Enter https://github.com/fviolette/doc-casual-contribution as the Git repository URL.
4. Click Browse.

Writing a new article

For the purpose of this test, creating a new article means editing the template located in your test folder.

1. Navigate to your test folder (e.g. cgauthier/, danderson/).
2. Select article.ditamap and click Choose.
3. Click Show Topic Titles to find the sections to edit more easily.
4. Open the sections you want to edit (e.g. what_is_concept.dita, list_of_components.dita).
5. Make all required edits (add new content, upload images).
6. When you are done, press Ctrl+S.
7. Enter a commit message.
8. Select the Create Pull Request automatically checkbox.
9. Click Commit.

Editing an existing article

1. Navigate to the _samples/ test folder.

2. Navigate into the article you want to edit.

   Published versions on the selected articles and corresponding folders:

   • Architecture - Talend Data Management Platform 6.1 (_samples/architecture_data_management_platform/)
   • Best Practice: Change Data Capture with Spark in Big Data (_samples/cdc_spark_big_data/)
   • Snowflake Components in Talend (_samples/snowflake)

3. Select the map file (staring by dm-) and click Choose.

4. Click Show Topic Titles to find the sections to edit more easily.

5. Open the sections you want to edit.

6. Make all required edits (add new content, upload images).

Committing my changes

1. When you are happy with your changes, press Ctrl+S.
2. Enter a commit message.
3. Select the Create Pull Request automatically checkbox.
4. Click Commit.

The Git connector will automatically do the following:

• Fork the project into your account, if it is not already.
• Create a new branch from the edited branch.
• Commit your changes on this newly created branch.
• Create a pull request from your newly created branch to the originally edited branch.
• Switch the editor to your branch so further save operations will just add new commits to your branch, thus updating the pull request with new changes.