Please use https://github.ibm.com/cloud-docs/Cloudant for contributions. Pushes to https://github.com/ibm-cloud-docs/Cloudant are only allowed by members of documentation team.
Jenkins is used to publish docs to staging and to production. The setup is managed by IBM Cloud Documentation team.
https://wcp-docs-team-jenkins.swg-devops.com/job/build/job/cloud-docs/job/Cloudant/
Jenkins is also used to keep github.com and github.ibm.com repositories in sync.
https://wcp-docs-team-jenkins.swg-devops.com/job/mirror/job/cloud-docs/job/Cloudant
Please use https://github.ibm.com/cloud-docs/Cloudant for contributions to the documentation. Pushes to https://github.com/ibm-cloud-docs/Cloudant are only allowed by members of the documentation team. See Documentation Update Process for instructions.
If you are not an IBM employee and want to make a documentation contribution, go to the IBM Cloudant documentation and click Feedback
on the page where you want to comment.
{{site.data.keyword.attribute-definition-list}}
tag - this enables the language switchers.{:new_window: target="_blank"}
, {:shortdesc: .shortdesc}
, {:codeblock: .codeblock}
or any others.Example snippets
{: node}
tag after {: codeblock}
tag instead of {: javascript}
. This keeps the order of the language switcher tabs as:curl
, Java
, Node
, Python
, and Go
.require
(Node built-in CommonJS modules) instead of import
(ES module) in the javascript examples.The following Example template can be helpful where the previous suggestions are included.
h2
, h3
, h4
, ...) header because any other order affects the order of the language switchers, and the language switcher does not display correctly.POST
verb too: curl -X POST $SERVICE_URL/... -H "Content-Type: application/json" --data '{...}'
.http
code blocks, like $SERVICE_URL
, $DATABASE
, $VIEW_NAME
and so on.
design-doc
, $DESIGN_ID
, $DDOC
, $DDOCS
in the same document. Try to use the most used in the whole doc (in this example, case $DDOC
).$SERVICE_URL
placeholder at the beginning of each path (in http
and language blocks too).curl
, java
, node
, python
, go
examples except for the "special" $SERVICE_URL
, use realistic data instead if you can e.g. animaldb
instead of the $DATABASE
placeholder etc