[api-quick-start] Some old translated pages are still being seen

Bug #1608992 reported by Ian Y. Choi
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack i18n
Fix Released
Undecided
Ian Y. Choi
openstack-api-site
Fix Released
Undecided
Ian Y. Choi
openstack-manuals
Fix Released
Undecided
Unassigned

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.)

Ian Y. Choi (ianychoi)
Changed in openstack-api-site:
assignee: nobody → Ian Y. Choi (ianychoi)
Changed in openstack-i18n:
assignee: nobody → Ian Y. Choi (ianychoi)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to api-site (master)

Fix proposed to branch: master
Review: https://review.openstack.org/350096

Changed in openstack-api-site:
status: New → In Progress
Revision history for this message
Ian Y. Choi (ianychoi) wrote :

Found that Chinese (zh-CN) and Indonesian (id) are enough to build translated documents for api-quick-start.

description: updated
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to api-site (master)

Reviewed: https://review.openstack.org/350096
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=1cb6084d34c09c66d2959d9033308bfc12699e37
Submitter: Jenkins
Branch: master

commit 1cb6084d34c09c66d2959d9033308bfc12699e37
Author: Ian Y. Choi <email address hidden>
Date: Wed Aug 3 00:06:59 2016 +0900

    [api-quick-start] Include more language builds

    Chinese (zh_CN) and Indonesian (id) have progress
    enough to generate translated documentations.

    Change-Id: Ie09b9999d82470f543db0257e631fe4234cac0ff
    Partial-Bug: #1608992

Revision history for this message
Ian Y. Choi (ianychoi) wrote :

https://review.openstack.org/353579 is addressing #3 (After checking the documentation result on public web pages, we need to add url redirection.)

Changed in openstack-manuals:
status: New → In Progress
assignee: nobody → Ian Y. Choi (ianychoi)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-manuals (master)

Reviewed: https://review.openstack.org/353579
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=7be1e397655b6299a3f454963328d8d316584625
Submitter: Jenkins
Branch: master

commit 7be1e397655b6299a3f454963328d8d316584625
Author: Ian Y. Choi <email address hidden>
Date: Thu Aug 11 00:22:22 2016 +0900

    [api] add redirect for translated quick-starts

    This commit proposes to redirect translated api quick-start
    documents, like the similar way as
    docs.o.o/api/quick-start/content/ is redirected to
    developer.o.o/api-guide/quick-start/ page.

    Currently the following four language versions are applied
    : de (German), ja (Japanese), ko_KR (Korean), zh_CN (Chinese).

    Change-Id: I74c4434301e75654832f06cd9e74fcffe4e37706
    Partial-Bug: #1608992

Revision history for this message
Ian Y. Choi (ianychoi) wrote :

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) → nobody
Changed in openstack-manuals:
status: In Progress → Fix Released
Revision history for this message
Ian Y. Choi (ianychoi) wrote :

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
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.