Closed ceciliachoi closed 5 years ago
Merged PR: https://github.com/IBM-Bluemix-Docs/SecureGateway/pull/16 for inline link format update
Merged PR: https://github.com/IBM-Bluemix-Docs/SecureGateway/pull/17 for unique topic id
Merged PR: https://github.com/IBM-Bluemix-Docs/SecureGateway/pull/18 for update topic id for each page for each language
SHORT TERM: Required changes to your STAGING CONTENT and TOC by Feb 19th: Short term MUST fixes that need to be READY TO PROMOTE ON Feb 19th to production:
Markdown content changes:
Inline links: Your inline links MUST use the correct format:
We now only support 2 types of inline links!
[Known issues] (#2april2018)
/docs/
:[Visual Recognition] (/docs/services/visual-recognition/getting-started.html)
Duplicate IDs: All anchor IDs across your entire Subcollection MUST BE UNIQUE:
https://console.test.cloud.ibm.com/docs/developing/writing?topic=writing-unique#unique
.TOC changes:
Example top of toc file: {: .toc subcollection="visual-recognition" service-name="Visual Recognition" arm="1102714" audience="service" href="/docs/services/visual-recognition/getting-started.html" path="services/visual-recognition"} Visual Recognition
subcollection
: Make sure your subcollection value in your toc is correct. In most cases this should match your subcollection folder name. This value is used to build your topic IDs, and it's critical that it is explicitly set. It should ALWAYS be lower case, with no spaces, hyphenated, and set like so: subcollection="visual-recognition" .href
: Make sure this value points to the HTML getting-started topic. This value is used for the breadcrumb link, and also if anyone navigated to the root folder path of your content without specifying a file. It should always start with /docs/, and be set like so: href="/docs/services/visual-recognition/getting-started.html" . NOTE: DO NOT UPDATE THIS TO USE TOPIC ID UNTIL AFTER FEB 19th.path
: This value is required in staging and production TODAY. You must set path value in your toc after docs/ and end at your subcollection folder name like so: path="services/visual-recognition" .