[OpenStack-docs] Restructure HTML templates / CSS files used on docs.o.o and in openstackdocstheme

Andreas Jaeger aj at microfocus.com
Tue Jan 19 20:59:25 UTC 2016


On 01/19/2016 05:03 PM, Jimmy McArthur wrote:
> I realize it creates a slight dependency on the OpenStack.org site, but
> we've created a really simple way for you all to always keep your menu
> up to date. Instructions just below. If there is an update to the menu
> that's desired, you can do a pull request against the openstack.org
> repository:
> https://github.com/OpenStackweb/openstack-org/blob/master/themes/openstack/templates/Layout/Includes/Navigation.ss
>
>
> This menu will update automatically when we update the file mentioned
> above. To see a sample of this, you can look here:
> http://devmenu.openstack.org/
>
> <nav class="navbar navbar-default" role="navigation">
> <div class="container">
> <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
> <ul id="menu_widget_container" class="nav navbar-nav navbar-main
> show"></ul>
> </div>
> </div>
> </nav>
>
> The only required element is the <ul> but the rest is necessary for
> styling purposes.
>
> Then include the widget :
> <script type="text/javascript"
> src="http://www.openstack.org/themes/openstack/javascript/menu-widget.js"></script>

This means we cannot test the changes without internet access. Is that 
still important for us?

Andreas

>
> Bootstrap and jquery are required as well.
>
> Please let me know if this is something you all are interested in
> implementing.
>
> Thanks!
> Jimmy McArthur
>
> Christian Berendt wrote:
>> On 01/19/2016 12:56 PM, Andreas Jaeger wrote:
>>> Also, you could enlarge this further and include URLs like
>>> http://specs.openstack.org/ or sub pages like
>>> http://docs.openstack.org/infra/ which are outside of documentation team
>>> scope but face a similar challenge and implemented it differently.
>>
>> Sure.
>>
>>> Or we could ask the foundation web master to create a master repo and
>>> use that to update all places. Getting those that update
>>> www.openstack.org involved is crucial IMHO.
>>
>> For the provided CSS files this makes sense, yes. This way it is easy
>> to track changes.
>>
>> Not sure if this makes sense for the HTML templates, because we
>> created templates based on the HTML sources we found on openstack.org.
>>
>>> Looking at the steps above, a spec might be useful so that we can
>>> discuss what's missing and what not - and have a written plan of action,
>>
>> Okay, I will prepare a spec for this topic.
>>
>> Christian.
>>
>
>


-- 
  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: 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




More information about the OpenStack-docs mailing list