[Bug 1608992] [NEW] [api-quick-start] Some old translated pages are still being seen
Public bug reported: Previously, API quick start documentation was xml-based format (with maven build). Since all the API quick start content is written as RST format now, docs.openstack.org/api/quick-start/ url is redirected to current API quick start URL like http://developer.openstack.org/api-guide/quick-start/index.html . I have found some of current problems which can be interpreted as bugs: - Not all translated RST documentation is visible : Although current translation is ~100% in Chinese (zh_CN), http://docs.openstack.org/zh_CN/api/quick-start/content/index.html (xml based) is okay, but http://developer.openstack.org/zh_CN/api-guide/quick-start/ url is not working. - No redirection to rst based documentation : For example, when users enter the previous Japanese API quick-start using docs.openstack.org/ja/api/quick-start/ , the old page is still being seen. On the other hand, English docs.openstack.org/api/quick-start url is redirected to current API quick start URL like http://developer.openstack.org/api-guide/quick-start/index.html . - Even though translation progress seems to be good, there is no rst- based generated documentation for zh_CN (Chinese) and id (Indonesia) So, currently, my approach to address this bug is: 1) Identify which languages have good progress on api-quick-start translation 2) Include that those languages need to build 3) After checking the documentation result on public web pages, we need to add url redirection. ** Affects: openstack-api-site Importance: Undecided Assignee: Ian Y. Choi (ianychoi) Status: In Progress ** Affects: openstack-i18n Importance: Undecided Assignee: Ian Y. Choi (ianychoi) Status: New ** Also affects: openstack-api-site Importance: Undecided Status: New ** Changed in: openstack-api-site Assignee: (unassigned) => Ian Y. Choi (ianychoi) ** Changed in: openstack-i18n Assignee: (unassigned) => Ian Y. Choi (ianychoi) -- You received this bug notification because you are a member of OpenStack I18n Core Team, which is subscribed to openstack i18n. https://bugs.launchpad.net/bugs/1608992 Title: [api-quick-start] Some old translated pages are still being seen Status in openstack-api-site: In Progress Status in openstack i18n: New Bug description: Previously, API quick start documentation was xml-based format (with maven build). Since all the API quick start content is written as RST format now, docs.openstack.org/api/quick-start/ url is redirected to current API quick start URL like http://developer.openstack.org/api-guide/quick-start/index.html . I have found some of current problems which can be interpreted as bugs: - Not all translated RST documentation is visible : Although current translation is ~100% in Chinese (zh_CN), http://docs.openstack.org/zh_CN/api/quick-start/content/index.html (xml based) is okay, but http://developer.openstack.org/zh_CN/api-guide/quick-start/ url is not working. - No redirection to rst based documentation : For example, when users enter the previous Japanese API quick-start using docs.openstack.org/ja/api/quick-start/ , the old page is still being seen. On the other hand, English docs.openstack.org/api/quick-start url is redirected to current API quick start URL like http://developer.openstack.org/api-guide/quick-start/index.html . - Even though translation progress seems to be good, there is no rst- based generated documentation for zh_CN (Chinese) and id (Indonesia) So, currently, my approach to address this bug is: 1) Identify which languages have good progress on api-quick-start translation 2) Include that those languages need to build 3) After checking the documentation result on public web pages, we need to add url redirection. To manage notifications about this bug go to: https://bugs.launchpad.net/openstack-api-site/+bug/1608992/+subscriptions
https://review.openstack.org/353579 is addressing #3 (After checking the documentation result on public web pages, we need to add url redirection.) ** Also affects: openstack-manuals Importance: Undecided Status: New ** Changed in: openstack-manuals Status: New => In Progress ** Changed in: openstack-manuals Assignee: (unassigned) => Ian Y. Choi (ianychoi) -- You received this bug notification because you are a member of OpenStack I18n Core Team, which is subscribed to openstack i18n. https://bugs.launchpad.net/bugs/1608992 Title: [api-quick-start] Some old translated pages are still being seen Status in openstack-api-site: In Progress Status in openstack i18n: New Status in openstack-manuals: In Progress Bug description: Previously, API quick start documentation was xml-based format (with maven build). Since all the API quick start content is written as RST format now, docs.openstack.org/api/quick-start/ url is redirected to current API quick start URL like http://developer.openstack.org/api-guide/quick-start/index.html . I have found some of current problems which can be interpreted as bugs: - Not all translated RST documentation is visible : Although current translation is ~100% in Chinese (zh_CN), http://docs.openstack.org/zh_CN/api/quick-start/content/index.html (xml based) is okay, but http://developer.openstack.org/zh_CN/api-guide/quick-start/ url is not working. - No redirection to rst based documentation : For example, when users enter the previous Japanese API quick-start using docs.openstack.org/ja/api/quick-start/ , the old page is still being seen. On the other hand, English docs.openstack.org/api/quick-start url is redirected to current API quick start URL like http://developer.openstack.org/api-guide/quick-start/index.html . - Even though translation progress seems to be good, there is no rst- based generated documentation for zh_CN (Chinese) and id (Indonesia) So, currently, my approach to address this bug is: 1) Identify which languages have good progress on api-quick-start translation 2) Include that those languages need to build 3) After checking the documentation result on public web pages, we need to add url redirection. 4) Change the link in pages who have previous links (e.g., http://docs.openstack.org/zh_CN/ has http://docs.openstack.org/zh_CN/api/quick-start/content/index.html , but changing to http://developer.openstack.org/zh_CN/api-guide/quick-start/ would be better after step 3.) To manage notifications about this bug go to: https://bugs.launchpad.net/openstack-api-site/+bug/1608992/+subscriptions
Update: The last step in this bug is to replace http://docs.openstack.org/zh_CN/api/quick-start/content/index.html with http://developer.openstack.org/zh_CN/api-guide/quick-start/ in Chinese landing page ( http://docs.openstack.org/zh_CN/ ). I can do it, but I encourage Chinese translators and/or contributors to change it in openstack/openstack-manuals repository ( www/zh_CN/index.html ), since I think it is low-hanging-fruit :) ** Changed in: openstack-api-site Status: In Progress => Fix Released ** Tags added: low-hanging-fruit ** Tags added: simplified-chinese ** Changed in: openstack-manuals Assignee: Ian Y. Choi (ianychoi) => (unassigned) -- You received this bug notification because you are a member of OpenStack I18n Core Team, which is subscribed to openstack i18n. https://bugs.launchpad.net/bugs/1608992 Title: [api-quick-start] Some old translated pages are still being seen Status in openstack-api-site: Fix Released Status in openstack i18n: New Status in openstack-manuals: In Progress Bug description: Previously, API quick start documentation was xml-based format (with maven build). Since all the API quick start content is written as RST format now, docs.openstack.org/api/quick-start/ url is redirected to current API quick start URL like http://developer.openstack.org/api-guide/quick-start/index.html . I have found some of current problems which can be interpreted as bugs: - Not all translated RST documentation is visible : Although current translation is ~100% in Chinese (zh_CN), http://docs.openstack.org/zh_CN/api/quick-start/content/index.html (xml based) is okay, but http://developer.openstack.org/zh_CN/api-guide/quick-start/ url is not working. - No redirection to rst based documentation : For example, when users enter the previous Japanese API quick-start using docs.openstack.org/ja/api/quick-start/ , the old page is still being seen. On the other hand, English docs.openstack.org/api/quick-start url is redirected to current API quick start URL like http://developer.openstack.org/api-guide/quick-start/index.html . - Even though translation progress seems to be good, there is no rst- based generated documentation for zh_CN (Chinese) and id (Indonesia) So, currently, my approach to address this bug is: 1) Identify which languages have good progress on api-quick-start translation 2) Include that those languages need to build 3) After checking the documentation result on public web pages, we need to add url redirection. 4) Change the link in pages who have previous links (e.g., http://docs.openstack.org/zh_CN/ has http://docs.openstack.org/zh_CN/api/quick-start/content/index.html , but changing to http://developer.openstack.org/zh_CN/api-guide/quick-start/ would be better after step 3.) To manage notifications about this bug go to: https://bugs.launchpad.net/openstack-api-site/+bug/1608992/+subscriptions
Finally found that my last comments were addressed by Andreas's patch: https://review.openstack.org/#/c/362350/ ** Changed in: openstack-i18n Status: New => Fix Released -- You received this bug notification because you are a member of OpenStack I18n Core Team, which is subscribed to openstack i18n. https://bugs.launchpad.net/bugs/1608992 Title: [api-quick-start] Some old translated pages are still being seen Status in openstack-api-site: Fix Released Status in openstack i18n: Fix Released Status in openstack-manuals: Fix Released Bug description: Previously, API quick start documentation was xml-based format (with maven build). Since all the API quick start content is written as RST format now, docs.openstack.org/api/quick-start/ url is redirected to current API quick start URL like http://developer.openstack.org/api-guide/quick-start/index.html . I have found some of current problems which can be interpreted as bugs: - Not all translated RST documentation is visible : Although current translation is ~100% in Chinese (zh_CN), http://docs.openstack.org/zh_CN/api/quick-start/content/index.html (xml based) is okay, but http://developer.openstack.org/zh_CN/api-guide/quick-start/ url is not working. - No redirection to rst based documentation : For example, when users enter the previous Japanese API quick-start using docs.openstack.org/ja/api/quick-start/ , the old page is still being seen. On the other hand, English docs.openstack.org/api/quick-start url is redirected to current API quick start URL like http://developer.openstack.org/api-guide/quick-start/index.html . - Even though translation progress seems to be good, there is no rst- based generated documentation for zh_CN (Chinese) and id (Indonesia) So, currently, my approach to address this bug is: 1) Identify which languages have good progress on api-quick-start translation 2) Include that those languages need to build 3) After checking the documentation result on public web pages, we need to add url redirection. 4) Change the link in pages who have previous links (e.g., http://docs.openstack.org/zh_CN/ has http://docs.openstack.org/zh_CN/api/quick-start/content/index.html , but changing to http://developer.openstack.org/zh_CN/api-guide/quick-start/ would be better after step 3.) To manage notifications about this bug go to: https://bugs.launchpad.net/openstack-api-site/+bug/1608992/+subscriptions
participants (1)
-
Ian Y. Choi