cloud-pak-data

Documentation repository for "Cloud Pak for Data" at pre-production output.production output.

ℹ️ Tip: If you want to give feedback about the documentation, create an issue.

Creating content

Follow these steps to add to the Cloud Pak for Data on IBM Cloud docs.

Before you begin

Set up your local development environment

• Visual Studio Code is the recommended editor. For more information, see Choose an editor.
• You can install a Markdown linter in Visual Studio Code that works with IBM Cloud docs. For more information, see Integrating the Markdown linter in VS Code.

Drafting content

All content starts from the source branch.

1. Clone this repo if you have write privileges. Otherwise, fork the repo.

2. Create a working branch from the source branch.

3. Make your changes to the Markdown content.

   • Cloud docs uses Markdown with a few custom extensions to source the docs. For tips about how to structure and style your docs with IBM Cloud Markdown, see Quick tips for authoring in IBM Cloud docs in "Creating solution, deployment, and migration guides".
   • Cloud docs also supports controlling content with tagging. For example, content within the <staging> </staging> tags is not displayed to the public. For more information, see Making updates to your docs.

4. Commit your updates.

5. Create a pull request from your branch or fork to source.

   1. A Jenkins job runs that commits content to the draft and review branches and opens a pull request to the publish branch.
   2. After a few minutes, you can see your changes in the IBM Cloud docs framework. Changes to draft are available at the internal /docs-draft/ location (https://test.cloud.ibm.com/docs-draft/cloud-pak-data?topic=cloud-pak-data-getting-started). Changes to review are available at the pre-production /docs/ location (https://test.cloud.ibm.com/docs/cloud-pak-data?topic=cloud-pak-data-getting-started).

ℹ️ Tip: Content that is tagged with <draft>, <review>, <staging>, or feature tags are built and promoted only to the internal location and is not included in the pull request to the publish branch for production.