Re: [openstack-dev] [storyboard][infra][docs] Report a bug and storyboard

2017-06-28 Thread Adam Coldrick

Hi Andreas,

On 2017-06-28 07:33, Andreas Jaeger wrote:

Hi Storyboard team,

the openstackdocstheme has a "Report a bug" feature, where you can 
click

on the Bug icon and get a link to project's bug area in launchpad
together with information about the documentation (bug tag, git URL of
build, date, SHA, extra text).

How can this be done with storyboard?


Currently there is no support for this exact functionality in StoryBoard 
itself.
You could add some JavaScript to the docs theme to make a POST request 
to the
StoryBoard API with the relevant parameters set, but this would need 
some work
to also get a valid StoryBoard access token to use in the request 
somehow.


Other than that you could settle for linking to an individual project 
view in
StoryBoard, for example https://storyboard.openstack.org/#!/project/456 
has a
button on it for logged-in users to create a story which automatically 
has a

task in that project.

The ability to construct an link to StoryBoard's web UI which 
automatically
populates part of the things needed to create a story seems generally 
useful
though. In particular I can see it potentially being helpful for 
resolving our
lack of bug templates, which has been raised as a problem on more than 
one

occasion.

Supporting this type of feature would allow folk to construct URLs which
automatically populate the description field with some template of their 
choice,
which should hopefully be useful enough to solve both that problem and 
the need
to replicate this "Report a bug" feature adequately. I intend to take a 
look at

how much work it'd be for us to implement that kind of thing in the near
future, and hopefully that'll lead to a more ideal solution than those I 
outlined

above.

Best Regards,

Adam

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev


[openstack-dev] [storyboard][infra][docs] Report a bug and storyboard

2017-06-28 Thread Andreas Jaeger
Hi Storyboard team,

the openstackdocstheme has a "Report a bug" feature, where you can click
on the Bug icon and get a link to project's bug area in launchpad
together with information about the documentation (bug tag, git URL of
build, date, SHA, extra text).

How can this be done with storyboard?

Example: See the Bug icon on https://docs.openstack.org/admin-guide/ .
It gives the following URL as time of writing:

https://bugs.launchpad.net/openstack-manuals/+filebug?field.title=OpenStack%20Administrator%20Guide%20in%20Administrator%20Guide=%0A%0A%0AThis%20bug%20tracker%20is%20for%20errors%20with%20the%20documentation,%20use%20the%20following%20as%20a%20template%20and%20remove%20or%20add%20fields%20as%20you%20see%20fit.%20Convert%20[%20]%20into%20[x]%20to%20check%20boxes:%0A%0A-%20[%20]%20This%20doc%20is%20inaccurate%20in%20this%20way:%20__%0A-%20[%20]%20This%20is%20a%20doc%20addition%20request.%0A-%20[%20]%20I%20have%20a%20fix%20to%20the%20document%20that%20I%20can%20paste%20below%20including%20example:%20input%20and%20output.%20%0A%0AIf%20you%20have%20a%20troubleshooting%20or%20support%20issue,%20use%20the%20following%20%20resources:%0A%0A%20-%20Ask%20OpenStack:%20http://ask.openstack.org%0A%20-%20The%20mailing%20list:%20http://lists.openstack.org%0A%20-%20IRC:%20%27openstack%27%20channel%20on%20Freenode%0A%0A---%0ARelease:%2015.0.0%20on%202017-06-27%2009:57%0ASHA:%20cc281cac69483977f3eed49f03f9bfac850cd7f0%0ASource:%20https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/source/index.rst%0AURL:%20https://docs.openstack.org/admin-guide/=admin-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

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev