[docs] question about deprecation badges

Sebastian Marcet smarcet at gmail.com
Sat Jan 5 04:19:21 UTC 2019

Hi Adam, that approach is followed in order to be consumed from other
projects like theme docs, using an ajax call doing a get and including its
content dynamically on the page, also the css dir its not used bc otherwise
it will not point to the rite css path on the fore-mentioned approach,
instead its using the absolute path in order to load the css correctly
through the ajax call ( check https://review.openstack.org/#/c/585516/)

on docs theme the deprecation badge is loaded using this snippet

<script type="text/javascript">

            context: this,
            dataType : "html",
            url : "https://docs.openstack.org/{{ series }}/badge.html",
            success : function(results) {

on file openstackdocstheme/theme/openstackdocs/layout.html

hope that shed some lite , have in mind that its a first iteration and any
better approach its welcome


El vie., 4 ene. 2019 a las 20:45, Adam Spiers (<aspiers at suse.com>) escribió:

> Hi all,
> I'm currently hacking on the deprecation badges in openstack-manuals,
> and there's a couple of things I don't understand.  Any chance someone
> could explain why www/latest/badge.html doesn't just do:
>     {% include 'templates/deprecated_badge.tmpl' %}
> like all the others?
> https://github.com/openstack/openstack-manuals/commit/961f544a4ec383d8b500afd82dda5dc333f689d1#diff-61d0adc734c25e15fa375c6acd344703
> I'm also what exactly would be wrong with the included CSS path if
> CSSDIR was used in www/templates/deprecated_badge.tmpl instead of
> heeding this caveat:
> https://github.com/openstack/openstack-manuals/commit/961f544a4ec383d8b500afd82dda5dc333f689d1#diff-67d1669c09d2cddc437c6d803a5d6c02R4
> It would be good to fix it to use CSSDIR because currently it's
> awkward to test CSS changes.
> Thanks!
> Adam

Sebastian Marcet
SKYPE: sebastian.marcet
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-discuss/attachments/20190105/3ea028ef/attachment.html>

More information about the openstack-discuss mailing list