[openstack-dev] Idea of adding the language index to individual release notes

Akihiro Motoki amotoki at gmail.com
Mon Jul 17 00:41:19 UTC 2017

# moving from personal emails to openstack-dev ML

Thanks Doug for the advise.

openstackdocstheme looks a better place to support the language index
for individual release note pages.
I will look into how we can support it in openstackdocstheme.

At now, the releasenote is built as a separate sphinx project, so the
openstackdocstheme support would be straight-forward just by checking
the availability of PO files for individual languages.
Once we move the doc build to more unified way, we might need more
fine-grained way to control the language index.
We can start some simple approach and then enhance it gradually.

2017-07-11 23:35 GMT+09:00 Doug Hellmann <doug at doughellmann.com>:
> On Jul 11, 2017, at 9:18 AM, Andreas Jaeger <aj at suse.com> wrote:
> On 2017-07-11 14:43, Akihiro Motoki wrote:
> Hi Doug, Ian, Andreas,
> I proposed a patch to add the language index to all release notes files.
> https://review.openstack.org/#/c/481850/
> Your feedback would be appreciated.
> Thanks Andreas for the initial feedback too.
> Release notes files are usually not accessed through index.html
> and release notes of individual releases are accessed directly as they
> are linked from releases.openstack.org.
> I think it is useful to have the language list for all release notes files
> so that readers can easily find translated versions.
> The similar approach is being proposed to the i18n guide.
> https://review.openstack.org/#/c/479472/
> Sample output is like this:
> http://docs-draft.openstack.org/72/479472/6/check/gate-i18n-tox-doc-publish-docs/91e920e//publish-docs/i18n/latest/
> Doug,
> here's one thing to look into when moving release-notes into main build
> - how to translate them. Do we translate the release notes separately
> (we can do that since each file is a separate translatable target) or
> only the full guide ?
> Andreas
> --
> Andreas Jaeger aj@{suse.com,opensuse.org} Twitter: jaegerandi
>  SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
>   GF: Felix Imendörffer, Jane Smithard, Graham Norton,
>       HRB 21284 (AG Nürnberg)
>    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126
> I replied on the review, but in case you didn’t see that message:
> I like the idea of doing this, but I'm not sure this is the right
> implementation, for 2 reasons:
> 1. We are going to have to solve a similar problem for content in the
> doc/source directories for projects (installation guides, especially).
> 2. The special releasenotes build job will go away when we merge it into
> doc/source and use the single unified job.
> Do you think it would be possible to do something in the openstackdocstheme
> to add the necessary links?
> Perhaps we can continue this discussion on openstack-dev?
> Doug

More information about the OpenStack-dev mailing list