NOTE: Kristin has created a tool that will help you search and replace each HTML inline link with a TopicID link! We will roll that out officially soon!
Update this value to point to the topic ID of your 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 updated to:
Your Catalog offering has a "View docs" link that points from the catalog to your documentation. This link also dynamically adds the correct link to the Doc App homepage. https://console.test.cloud.ibm.com/docs/developing/writing?topic=writing-urls#urls. This value needs to be updated in either RMC or the resource-catalog UI to use topic ID:
"urls": {
~"doc_url": "/docs/services/visual-recognition/getting-started.html",~
"doc_url": "/docs/services/visual-recognition?topic=visual-recognition-getting-started-tutorial",
~"instructions_url": "/docs/services/visual-recognition/getting-started.html",~
"instructions_url": "/docs/services/visual-recognition?topic=visual-recognition-getting-started-tutorial",
"terms_url": "https://www-03.ibm.com/software/sla/sladb.nsf/sla/bm-0026-05",
"apidocs_url": "/apidocs/visual-recognition"
},
Getting started link in console (Instructions URL)
After a user provisions an instance of your offering from the catalog, a console service dashboard is generated and when Instructions URL is set, your getting started topic is reused and pulled into the Getting Started tab of the dashboard. https://console.test.cloud.ibm.com/docs/developing/writing?topic=writing-urls#urls. This value needs to be updated in either RMC or the resource-catalog UI to use topic ID:
"urls": {
~"doc_url": "/docs/services/visual-recognition/getting-started.html",~
"doc_url": "/docs/services/visual-recognition?topic=visual-recognition-getting-started-tutorial",
~"instructions_url": "/docs/services/visual-recognition/getting-started.html",~
"instructions_url": "/docs/services/visual-recognition?topic=visual-recognition-getting-started-tutorial",
"terms_url": "https://www-03.ibm.com/software/sla/sladb.nsf/sla/bm-0026-05",
"apidocs_url": "/apidocs/visual-recognition"
},
Console links to docs (learn more…)
Progressive disclosure is important, and depending on what part of IBM Cloud you are working on, you will need to update an existing Learn more links in the console to use the topic ID format URL.
ceciliachoi
commented
5 years ago
Long term MUST fix by May 23rd in production (can start pushing to production starting Feb 19th when doc app code promotes) :
Markdown content changes:
Inline links:
TOC changes:
Example top of toc file:
href
Update this value to point to the topic ID of your 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 updated to:
Console changes
Catalog link (Documentation URL)
Your Catalog offering has a "View docs" link that points from the catalog to your documentation. This link also dynamically adds the correct link to the Doc App homepage. https://console.test.cloud.ibm.com/docs/developing/writing?topic=writing-urls#urls. This value needs to be updated in either RMC or the resource-catalog UI to use topic ID: "urls": { ~"doc_url": "/docs/services/visual-recognition/getting-started.html",~ "doc_url": "/docs/services/visual-recognition?topic=visual-recognition-getting-started-tutorial", ~"instructions_url": "/docs/services/visual-recognition/getting-started.html",~ "instructions_url": "/docs/services/visual-recognition?topic=visual-recognition-getting-started-tutorial", "terms_url": "https://www-03.ibm.com/software/sla/sladb.nsf/sla/bm-0026-05", "apidocs_url": "/apidocs/visual-recognition" },
Getting started link in console (Instructions URL)
After a user provisions an instance of your offering from the catalog, a console service dashboard is generated and when Instructions URL is set, your getting started topic is reused and pulled into the Getting Started tab of the dashboard. https://console.test.cloud.ibm.com/docs/developing/writing?topic=writing-urls#urls. This value needs to be updated in either RMC or the resource-catalog UI to use topic ID: "urls": { ~"doc_url": "/docs/services/visual-recognition/getting-started.html",~ "doc_url": "/docs/services/visual-recognition?topic=visual-recognition-getting-started-tutorial", ~"instructions_url": "/docs/services/visual-recognition/getting-started.html",~ "instructions_url": "/docs/services/visual-recognition?topic=visual-recognition-getting-started-tutorial", "terms_url": "https://www-03.ibm.com/software/sla/sladb.nsf/sla/bm-0026-05", "apidocs_url": "/apidocs/visual-recognition" },
Console links to docs (learn more…)
Progressive disclosure is important, and depending on what part of IBM Cloud you are working on, you will need to update an existing Learn more links in the console to use the topic ID format URL.