settingsLogin | Registersettings

Questions in openstack-docs

Search:
CategoryQuestionAnswer

[OpenStack-docs] [training-guides] team meeting time conflict

Cores, please run the meeting without me again this week. I am in the midst
of hiring a bunch of people and I just don't have any spare time my Monday
morning. I will pop back up mid-week. Thanks.

~ sean


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Alright.

Regards,
Sayali.

On Mon, Apr 20, 2015 at 12:04 PM, sean roberts seanroberts66@gmail.com
wrote:

Cores, please run the meeting without me again this week. I am in the
midst of hiring a bunch of people and I just don't have any spare time my
Monday morning. I will pop back up mid-week. Thanks.

~ sean


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Re: [OpenStack-docs] [install-guide] Open vSwitch versions

On 04/17/2015 08:37 PM, Matt Kassawara wrote:

For those working on RH/CentOS, Fedora, SLES, and openSUSE... what
version of Open vSwitch do you get with the Kilo packages? Ubuntu jumped
to 2.3.1.

openSUSE: 2.3.1
SLES 12: 2.1.2

Andreas
--
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, Jennifer Guild, Dilip Upmanyu,
Graham Norton, HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 04/20/2015 08:40 AM, Andreas Jaeger wrote:
On 04/17/2015 08:37 PM, Matt Kassawara wrote:

For those working on RH/CentOS, Fedora, SLES, and openSUSE... what
version of Open vSwitch do you get with the Kilo packages? Ubuntu jumped
to 2.3.1.

openSUSE: 2.3.1
SLES 12: 2.1.2

If 2.3.1 is needed for SLES, tell us and we can document how to install
a newer package version,

Andreas
--
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, Jennifer Guild, Dilip Upmanyu,
Graham Norton, HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [install-guide] usage of ec2authtoken in Heat section

In the installation guide we configure the ec2authtoken
(http://docs.openstack.org/draft/install-guide/install/yum/content/heat-install-controller-node.html).

Is this necessary? We do not set up the EC2 API on the Nova controller
node and at the moment I do not understand why we configure the EC2
token and think that it can be removed.

[ec2authtoken]
...
auth_uri = http://controller:5000/v2.0

Christian.

--
Christian Berendt
Cloud Solution Architect
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

If we don't need it, get rid of it.

On Mon, Apr 20, 2015 at 8:36 AM, Christian Berendt christian@berendt.io
wrote:

In the installation guide we configure the ec2authtoken (
http://docs.openstack.org/draft/install-guide/install/yum/content/heat-install-controller-node.html
).

Is this necessary? We do not set up the EC2 API on the Nova controller
node and at the moment I do not understand why we configure the EC2 token
and think that it can be removed.

[ec2authtoken]
...
auth_uri = http://controller:5000/v2.0

Christian.

--
Christian Berendt
Cloud Solution Architect
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Re: [OpenStack-docs] [install-guide] minimal requirements for a proof-of-concept environment

I agree with Roger, the minimum requirements for training guides cluster
are as given by him and we have reasonable performance (atleast everything
works!). For smaller flavors (custom) even 512MB compute node would work
well.

On Thu, Apr 16, 2015 at 8:38 PM, Roger Luethi rl@patchworkscience.org
wrote:

The training-labs scripts currently install OpenStack with this config:

controller: 1 processor, 1 GB RAM
network: 1 processor, 512 MB RAM
compute: 2 processors, 1 GB RAM

Main issue is that you can't start a whole lot of instances on compute with
1 GB RAM. Then again, you catch some interesting corner cases.

So yes, this does work for a proof of concept environment. I suspect a)
that having 2 processors on compute is not strictly necessary and b) it
will still work once we're done adding heat and ceilometer (in progress).

I wouldn't recommend putting any serious load on such an environment,
though, unless you are studying failure modes.

Roger

On Wed, 15 Apr 2015 11:22:37 +0200, Christian Berendt wrote:

At the moment we mention the following minimum requirements for a
proof-of-concept environment in chapter 2 (basic environment):

---snip---
Controller Node: 1 processor, 2 GB memory, and 5 GB storage

Network Node: 1 processor, 512 MB memory, and 5 GB storage

Compute Node: 1 processor, 2 GB memory, and 10 GB storage
---snap---

Does this really work? Has anybody tried to run a network node with only
512 MByte memory? Or a controller node with RabbitMQ, MySQL, MongoDB and
a lot of OpenStack services with 1 VCPU and 2 GByte memory?

I would propose to increase the minimum requirements:

Controller Node: 4 processors, 8 GB memory, and 15 GB storage
Network Node: 2 processors, 4 MB memory, and 10 GB storage
Compute Node: 2 processors, 4 GB memory, and 20 GB storage

Christian.


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Re: [OpenStack-docs] [install guide] Re: Openstack client errors

With new installation of the cluster this problem vanished for me on
opensuse. Not sure why!

Regards,
Pranav

On Fri, Apr 17, 2015 at 12:21 PM, Bernd Bausch berndbausch@gmail.com
wrote:

It turns out that this early RDO release misses SELinux rules for
memcached. This prevents OpenStack processes from accessing a memcached
socket (or something like that).

Adding those rules manually or running permissive SELinux fixes this.

From: Matt Kassawara [mailto:mkassawara@gmail.com]
Sent: Friday, April 17, 2015 1:58 AM
To: Bernd Bausch
Cc: Pranav Salunke; openstack-docs@lists.openstack.org
Subject: Re: [OpenStack-docs] [install guide] Re: Openstack client
errors

You should check the default configuration for memcached. Make sure it's
listening on localhost:11211 and no firewall blocking it.

On Thu, Apr 16, 2015 at 10:29 AM, Bernd Bausch berndbausch@gmail.com
wrote:

The command works for me (Centos).

Note however that I replaced the memcached token backend with SQL. With
the memcached, trying to log on and get a token (openstack token issue)
just hangs on my system. I hope the RDO mailing list will be able to help.

Bernd

From: Pranav Salunke [mailto:dguitarbite@gmail.com]
Sent: Friday, April 17, 2015 12:01 AM
To: openstack-docs@lists.openstack.org
Subject: [OpenStack-docs] [install guide] Re: Openstack client errors

Hello,

I get the following error on opensuse in the section "Verify operation".
This is the following errors:

controller:/home/osbash # openstack --os-auth-url http://controller:35357
\

--os-project-name admin --os-username admin --os-auth-type password \
project list
Password:
ERROR: openstack An unexpected error prevented the server from fulfilling
your request. (HTTP 500) (Request-ID:
req-37c9300f-4348-4180-8881-dd3ab921a766)

It would be great someone can confirm that there are same issues with
other distros for this client.

Regards,

Pranav


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Adding to Install documentation

Hello,

As you may have heard, VMware recently released its own OpenStack distro (VMware Integrated OpenStack, available for free).

What is the process for including the installation instructions to the OpenStack documentation? SUSE, RedHat, and Ubuntu have installation guides on the site, so I expect VMware's can be included also.

If yes, there is the question of logistics. The install guides for the above appear to be a single installation guide with variables and conditional content. The VMware distro is completely differently, as it is installed and deployed via an installer. I am not sure that it be as simple as modifying the existing install topics.

Please advise!

Best

Andy Dugas


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Hi Andy,

The upstream installation guide only covers a simple, manual installation
from mostly stock packages provided by several distributions. Guides for
all automated/opinionated/complex products such Mirantis Fuel and
RDO/Packstack reside outside of the upstream documentation tree.

Matt

On Mon, Apr 20, 2015 at 12:22 PM, Andy Dugas adugas@vmware.com wrote:

Hello,

As you may have heard, VMware recently released its own OpenStack distro
(VMware Integrated OpenStack, available for free).

What is the process for including the installation instructions to the
OpenStack documentation? SUSE, RedHat, and Ubuntu have installation guides
on the site, so I expect VMware's can be included also.

If yes, there is the question of logistics. The install guides for the
above appear to be a single installation guide with variables and
conditional content. The VMware distro is completely differently, as it is
installed and deployed via an installer. I am not sure that it be as simple
as modifying the existing install topics.

Please advise!

Best

Andy Dugas


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [training-guides][osbash] zero_empty.sh

Hello,

I would like to discuss the need for zeroing out the base disk done by
zero_empty.sh.

The significant advantage of this script is to zero out the remaining
unused space in the disk which helps in compression of the disk. But this
comes with the following disadvantages:

  1. Time required to create base disk is increased (zeroing out takes
    some time)
  2. Disk space used is the max. size of the disk - makes thin
    provisioning pointless. Thin provisioning of the disks is really useful and
    should be considered.
  3. Increasing the disk space will significantly increase the time taken
    for creating the base-disk and hence it may take hours for a cluster having
    50+GB disk size.
  4. Increase in the services and increasing demand to run heavier and
    more useful images apart from Cirros image makes this important point to
    consider.

I strongly believe that the loss in compression would be insignificant as
compared to the other benefits. I would like to hear from our team about
this.

Regards,
Pranav


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

I have no strong feelings about keeping zero_empty.sh, but personally I
would find the suggestion more compelling if it was not based on "it may
take hours" and "I strongly believe".

How about some hard data on actual benefits and costs of zero_empty.sh?

On Tue, 21 Apr 2015 12:09:33 +0200, Pranav Salunke wrote:
1. Time required to create base disk is increased (zeroing out takes
some time)

Indeed.

  1. Disk space used is the max. size of the disk - makes thin
    provisioning pointless. Thin provisioning of the disks is really useful and
    should be considered.

So in practical terms, what could we do that we cannot do right now?

  1. Increasing the disk space will significantly increase the time taken
    for creating the base-disk and hence it may take hours for a cluster having
    50+GB disk size.

That's not likely to be the default anytime soon, and if somebody wants
to build a large cluster, they can always comment the script out.

  1. Increase in the services and increasing demand to run heavier and
    more useful images apart from Cirros image makes this important point to
    consider.

Okay, that's really still point 3.

I strongly believe that the loss in compression would be insignificant as
compared to the other benefits. I would like to hear from our team about
this.

As I said, I don't care much either way. But I would like us to make
informed decisions, or at least be honest about it if we are acting based
on a hunch :-).

Roger


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [install guide] team meeting uncertain

Hi,

The Install Guide team meeting today is scheduled for about 45 minutes from now (13:00 UTC / 8:00 AM US CDT), but I have an overlapping meeting and I know of at least two other people with conflicts. So please feel free to meet without me, but if it ends up washing out, please send me status updates directly, and I'll compile everything into an update for the openstack-docs list.

Thanks!

-Karin


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Re: [OpenStack-docs] [Openstack] For Kilo (draft document), should we "Install and Configure" using the command "keystone" or "openstack"?

On 04/21/2015 05:10 PM, Martinx - ジェームズ wrote:

Hello Stackers!

I'm evaluating Kilo on top of Ubuntu 14.04.2, by following the document
(draf):

http://docs-draft.openstack.org/78/174878/5/check/gate-openstack-manuals-tox-doc-publish-checkbuild/38d6b1e//publish-docs/trunk/install-guide/install/apt/

But, the first "Install and Configure" pages of the documents, for:
Keystone, Glance, Nova and Neutron, the documents uses the command
"openstack" and, for Cinder and Heat, the documents uses the "keystone"
command... Is that right? Or the draft needs to be updated?

This is a draft document and we're working heavily on it. There are
already patches out there to update this but let's bring this to the
attention of the documentation team,

Andreas

Pages that uses new "openstack" command:

http://docs-draft.openstack.org/78/174878/5/check/gate-openstack-manuals-tox-doc-publish-checkbuild/38d6b1e//publish-docs/trunk/install-guide/install/apt/content/keystone-services.html

http://docs-draft.openstack.org/78/174878/5/check/gate-openstack-manuals-tox-doc-publish-checkbuild/38d6b1e//publish-docs/trunk/install-guide/install/apt/content/keystone-users.html

http://docs-draft.openstack.org/78/174878/5/check/gate-openstack-manuals-tox-doc-publish-checkbuild/38d6b1e//publish-docs/trunk/install-guide/install/apt/content/glance-install.html

http://docs-draft.openstack.org/78/174878/5/check/gate-openstack-manuals-tox-doc-publish-checkbuild/38d6b1e//publish-docs/trunk/install-guide/install/apt/content/ch_nova.html#nova-controller-install

http://docs-draft.openstack.org/78/174878/5/check/gate-openstack-manuals-tox-doc-publish-checkbuild/38d6b1e//publish-docs/trunk/install-guide/install/apt/content/neutron-controller-node.html

Pages that uses "old" "keystone" command:

http://docs-draft.openstack.org/78/174878/5/check/gate-openstack-manuals-tox-doc-publish-checkbuild/38d6b1e//publish-docs/trunk/install-guide/install/apt/content/cinder-install-controller-node.html

http://docs-draft.openstack.org/78/174878/5/check/gate-openstack-manuals-tox-doc-publish-checkbuild/38d6b1e//publish-docs/trunk/install-guide/install/apt/content/heat-install-controller-node.html

From what I'm seeing, the Kilo install document (draft, I know), is
outdated for Cinder and for Heat, am I right?

--
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, Jennifer Guild, Dilip Upmanyu,
Graham Norton, HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 04/21/2015 05:38 PM, Andreas Jaeger wrote:
This is a draft document and we're working heavily on it. There are
already patches out there to update this but let's bring this to the
attention of the documentation team,

The pending review request to replace the keystone client with the
openstack client is available at https://review.openstack.org/#/c/174723/.

Christian.

--
Christian Berendt
Cloud Solution Architect
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Installation guide patch reviews

I see quite a few installation guide patches waiting for a second +2 and
approval... and some needing their first +2. I'm particularly concerned
about patches that lead to merge/rebase issues because they address similar
issues throughout the guide. Can anyone help move these through?

https://review.openstack.org/#/q/status:open+project:openstack/openstack-manuals,n,z

Thanks!


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 22/04/15 03:51, Matt Kassawara wrote:
I see quite a few installation guide patches waiting for a second +2 and
approval... and some needing their first +2. I'm particularly concerned
about patches that lead to merge/rebase issues because they address similar
issues throughout the guide. Can anyone help move these through?

https://review.openstack.org/#/q/status:open+project:openstack/openstack-manuals,n,z

I'm on it.

L


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVNwebAAoJELppzVb4+KUySQwH/iK6ubgSIohmmY3arnkUF+CT
d4pu7fcet/AoA3UY2zXY44bE/4Xhcy0mWOmVifrGrpzDzeKLrU9M1iaM1g4qlUon
lE3tbtPGdjyeG4z6nkN8JJaYgngfOHidUQPVSP9ycxqrisxz8QtasAZKuTMbE1cO
BppOyPwNuohehjRr0bb1sb6zQ0IsEqD07s9ZUvN50umnMcMGe2DlYRl8TdfZNB5Q
UbqLNeMHcNNZMjnFArkoPLmqyi8b+tjd4IMb6QX0s4tN8vTbOOBJHeDK+ZYrmU/n
4nePs+ZS9QuS/W7kacWEiioLHu5fMaPql1TVeWN9La6u1hXfAfArh1A4oqbWHxQ=
=9Gbf
-----END PGP SIGNATURE-----


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Doc team meeting Wed

See you all at the doc team meeting tomorrow, Wednesday April 22, 2015,
1400 UTC in #openstack-meeting.

Agenda here:
https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

Thanks,
Anne

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [training-guides][upstream-training]

Hello Stefano, Sean,

Can I get your reviews on the upstream-training related patches so that I
can merge them asap since we are getting close to the summit. I think most
of them are by Matjaz.

https://review.openstack.org/#/q/owner:%22Matjaz+Pancur%22+status:open,n,z

Regards,
Pranav


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Project name convention

Hi,

I have a question on the doc team convention on capitalization on project names.
https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_project_names

Reviews which apply this convention to Horizon developer docs
are recently proposed. I would like to ask these change match
the intention of the doc team.

Personally I prefer the capitalized version of project names such as
Nova, Glance since they are normal words which have meanings
and I think capitalizing project names highlights that it is OpenStack
project names.
It is just my 2 cents.

Thanks,
Akihiro


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

This is the link of Horizon reviews I mentioned in the last mail.
https://review.openstack.org/#/q/status:open+project:openstack/horizon+branch:master+topic:bug/1446253,n,z

2015-04-23 6:43 GMT+09:00 Akihiro Motoki amotoki@gmail.com:

Hi,

I have a question on the doc team convention on capitalization on project names.
https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_project_names

Reviews which apply this convention to Horizon developer docs
are recently proposed. I would like to ask these change match
the intention of the doc team.

Personally I prefer the capitalized version of project names such as
Nova, Glance since they are normal words which have meanings
and I think capitalizing project names highlights that it is OpenStack
project names.
It is just my 2 cents.

Thanks,
Akihiro


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [User Guides] Meeting tomorrow

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi everyone,

Just a reminder that the User Guide SG meeting is on tomorrow. Please
ping me if you don't have it in your cal.

Please make sure you've had a chance to look at the blueprint before then:

https://blueprints.launchpad.net/openstack-manuals/+spec/reorganise-user-guides

L


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVOJhxAAoJELppzVb4+KUyNdkIANHQbaUgEC9g/ndsqhbuqKUu
fCrasKlckhVlaOEAignSuuuBa4vhxJz/Esa4+12ryUeGL9EWAENlVpVtBfNbhXQF
tIG8WIDHV1uILIvypKKO9nefUXabdw3kbnE41/b108YapyoCU3amgjk/GKqdFWw0
DhJ1o/lQZ53SSJW5CvCsZ5QLmJ8dJBzBa8BphtuIDAPyox2ikyNq+NkQcZS3nF0Y
mZgo0TpaBhoSl0hzHUNDdHU4iTDOUSvhDYrrtRlaRGN2JOZw4HoQhylmwjZKbDM3
AL4wsgP/B9TAnuSFsxY+2ze17Kds7vZdRRuzwanZgRTYg4CbI2o7P8FgoYR9Flc=
=UgVX
-----END PGP SIGNATURE-----


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] When to change a bug from fix-committed to fix-released?

Having a look at the bug reports I want to clarify the usage of the
following statuses:

fix-committed and fix-released

I changed the status of
https://bugs.launchpad.net/openstack-manuals/+bug/1311067 to
fix-committed. It is a change in the config-reference. Is it correct to
change the status directly from fix-committed to fix-released?

Christian.

--
Christian Berendt
Cloud Solution Architect
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On Thu, Apr 23, 2015 at 5:49 AM, Christian Berendt christian@berendt.io
wrote:

Having a look at the bug reports I want to clarify the usage of the
following statuses:

fix-committed and fix-released

I changed the status of
https://bugs.launchpad.net/openstack-manuals/+bug/1311067 to
fix-committed. It is a change in the config-reference. Is it correct to
change the status directly from fix-committed to fix-released?

I'm looking at the bug and this:
https://wiki.openstack.org/wiki/Documentation/HowTo#Doc_Bug_Triaging_Guidelines

Basically, since the last patch was "Partial-bug" I think the automation
sets it to In Progress. I don't think it should be set to "fix-released" if
a partial fix doesn't fix it all the way. Something between the automation
and partial didn't work right I think. Plus, the security doc people want
to work on it in their guide. So I think the Partial-bug in the commit
message was correct, and the bug should be set back to "Confirmed."

Does that make sense? Not sure how to capture that scenario on our wiki
page, but it matches what's documented.
Anne

Christian.

--
Christian Berendt
Cloud Solution Architect
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] FYI: Smaller translation imports

I've written a change [1] to reduce the size of our translation files.
This removes the location information from the translation files as well
as untranslated strings. This should significantly reduce the amount of
change that translations bring in. For details see also this thread with
the translation team [2].

Note that the first import will be large since it removes all location
information. The following imports should be really small...

Let's see whether everything works as expected. If you notice any
problems with the daily import, please tell me directly.

Andreas

[1]
https://review.openstack.org/#/c/176313/4
[2]
http://lists.openstack.org/pipermail/openstack-i18n/2015-April/thread.html#1061
--
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, Jennifer Guild, Dilip Upmanyu,
Graham Norton, HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] the status of creating volume always stay creating and no volume was create successfully

I read openstack-install-guide-apt-juno.pdf very carefully, and according to it ,I know openstack component such as keystone, nova, neutron, glance a lot, very brilliant guide. Thanks.

 

when I install block service completely, I create cloud disk in dashboard, but I cannot create volume successfully. What’s wrong ?

 

Resending my message without the attached screenshot.

openstack-docs is about improving the documentation and is not the best
place to ask technical questions. You are better off with resources like
ask.openstack.org or the general openstack mailing list.

Having said that, there are a few simple troubleshooting steps you could
try.

Use the command line tools to analyse the situation. cinder volume-list and
cinder volume-show disk7 might provide more specific information than just
“creating”.

Check if the cinder services are running and reachable. You need at least
scheduler and volume. cinder service-list will show you which services the
controller sees.

See if you find anything in the log files. Start with cinder-api, then
cinder-schedule, then, on the storage nodes, cinder-volume.

Set the debug option in the cinder configuration files, reproduce the
problem and look at the log files again (brace for LOTS of output).

Bernd.

From: 胡玉鹏 [mailto:huyp@inspur.com]
Sent: Friday, April 24, 2015 6:27 PM
To: openstack-docs@lists.openstack.org

Subject: [OpenStack-docs] the status of creating volume always stay creating
and no volume was create successfully

I read openstack-install-guide-apt-juno.pdf very carefully, and according to
it ,I know openstack component such as keystone, nova, neutron, glance a
lot, very brilliant guide. Thanks.

when I install block service completely, I create cloud disk in dashboard,
but I cannot create volume successfully. What’s wrong ?


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Re: [OpenStack-docs] global requirements for doc packages?

On 04/17/2015 07:45 PM, Andreas Jaeger wrote:

I'm going with c now after some discussion on IRC with Anne and updated
my patch:
https://review.openstack.org/173201

Note, I still thing we should not have conflicting requirements with
global requirements, so a "update.py --soft openstack-manuals" should be
imported regularly.

But this gives us the freedom to require in our repos openstackdocstheme

1.0.7 without a change to requirements.txt,

The patch has merged now, so only openstack-doc-tools is part of the
requirements process.

During review, please assure that we have no conflicts with
global-reqiurements,

Andreas
--
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, Jennifer Guild, Dilip Upmanyu,
Graham Norton, HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[openstack-dev] What's Up Doc? Apr. 24 2015

Redirect madness (March madness was over too soon)
Sorry to bring down the docs site for a while (in my overnight) earlier
today. Thanks to Sean Dague and Andreas Jaeger for quick help. We now have
three of us with the ability to fix it quickly without waiting for builds
to finish. Our hope is to get off of FTP dependence next release and move
to object store (swift) for the site next release.

You may still see oddities around the /trunk /draft moves in Google
searches, but I am already seeing top hits changing for the End User Guide
and Admin User Guide, so I expect we're out of the woods.

Kilo release: cutting a stable branch
I would love to cut a stable/kilo branch a week from today, but of course
we always evaluate day-by-day, week-by-week on the completeness of the
Configuration Reference and Install Guides.

Networking Guide sprint and Bug Triage day 4/23
Thanks to those who could help out for the sprint and bug triage day.
Really appreciate the thoughtfulness on this day about doc bugs. While our
numbers didn't budge much for openstack-manuals, the downward trend in
openstack-api-site this release has been impressive, dang. Thanks Diane
especially for the diligence in bug fixes. Check out
http://webnumbr.com/untouched-bugs-in-openstack-api-site.

First App Tutorial
Good progress on cleanup patches for the First App Tutorial. We'll publish
on developer.openstack.org once it's sufficiently edited.

Doc team meeting

We met this week, see the minutes here to catch up:
http://eavesdrop.openstack.org/meetings/docteam/2015/docteam.2015-04-22-14.00.html

We want to switch to a different meeting schedule; alternating weeks rather
than first/third, second/fourth. Please weigh in on times for the new
schedule.

Liberty Design Summit
Be sure to put your ideas in the etherpad at
https://etherpad.openstack.org/p/Docs_Liberty_Design_Sessions
Lana will fit those into the schedule at
https://docs.google.com/spreadsheets/d/1VsFdRYGbX5eCde81XDV7TrPBfEC7cgtOFikruYmqbPY/edit?usp=sharing
and we'll see you in Vancouver!

--
Anne Gentle
annegentle@justwriteclick.com__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: OpenStack-dev-request@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

On 04/24/2015 04:32 PM, Anne Gentle | Just Write Click wrote:
[...]
First App Tutorial
Good progress on cleanup patches for the First App Tutorial. We'll
publish on developer.openstack.org once
it's sufficiently edited.

Where should the draft go? https://review.openstack.org/177184 would
publish on docs.openstack.org/draft - is that ok?

Or should we publish the draft on developer.openstack.org/draft/ ?

Andreas
--
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, Jennifer Guild, Dilip Upmanyu,
Graham Norton, HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Requesting help on a docs bug / issue for Orchestration / Heat API docs

Hello,

I recently worked on this bug:
https://bugs.launchpad.net/openstack-api-site/+bug/1411394

With this patchset:
https://review.openstack.org/#/c/147644/

However, the effect was not the intended one and I am seeking help on
how to fix it.

The original problem was the all of the snapshot action urls were the same:
https://review.openstack.org/#/c/147644/2/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl

But the problem was the the restore snapshot api call used a different
url (having '/restore' appended to the original docs url).

I thought I was fixing it, but now the docs are horribly munged and
appear worse for the patch :/

I apologize for this and humbly seek any assistance on how this code
actually works so that I can remedy my mistake.

Thank you,
Patrick Crews


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Patrick, I'll take a look tonight. 

Sent from my Verizon Wireless 4G LTE smartphone

-------- Original message --------
From: pcrews gleebix@gmail.com
Date: 04/24/2015 1:24 PM (GMT-06:00)
To: openstack-docs@lists.openstack.org
Subject: [OpenStack-docs] Requesting help on a docs bug / issue for
Orchestration / Heat API docs

Hello,

I recently worked on this bug:
https://bugs.launchpad.net/openstack-api-site/+bug/1411394

With this patchset:
https://review.openstack.org/#/c/147644/

However, the effect was not the intended one and I am seeking help on
how to fix it.

The original problem was the all of the snapshot action urls were the same:
https://review.openstack.org/#/c/147644/2/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl

But the problem was the the restore snapshot api call used a different
url (having '/restore' appended to the original docs url).

I thought I was fixing it, but now the docs are horribly munged and
appear worse for the patch :/

I apologize for this and humbly seek any assistance on how this code
actually works so that I can remedy my mistake.

Thank you,
Patrick Crews


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [install guide] updates (was Re: What's Up Doc? Apr. 24 2015)

On 4/24/15, 1:32 PM, "Christian Berendt" christian@berendt.io wrote:

I think we have this week made good progress in the overworking of the
Instalation Guide and that we can finish next week. Karin, can you
please post a summarization of the progress?

Sure; sorry I didn't get to this earlier; this has been something of a
week.

  • Ubuntu: Matt was able to work around the nova instance blocker[1], which
    has been progressing.
  • Fedora/RHEL/Centos: lots of progress reported from Christian; legacy
    network, database, and data processing service have not yet been tested
    (as of yesterday), but the other main components have been successfully
    tested.
  • If you have any updates for the progress table[2], please update it.

Do we have any news regarding the Debian Installation Guide? At the
moment this guide is not ready for kilo and we should discuss if we want
to publish /kilo/install-guide/install/apt/content/ after the release of
kilo. If we decide to not publish the Debian Installation Guide for kilo
we should discuss if we want to remove all Debian related content from
the the files.

I haven't heard anything on Debian yet, myself.

[1] https://bugs.launchpad.net/bugs/1439280
[2] https://wiki.openstack.org/wiki/KiloDocTesting


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [install-guide] rework of sahara and trove chapter

The content provided for sahara and trove does not fit with the other
chapters. The note "This chapter is a work in progress. It may contain
incorrect information, and will be updated frequently." on the first
page in the chapter was added a long time ago and nothing happend there.

I think we need to rework the whole content and should remove both
chapters from the installation guide for the moment.

https://review.openstack.org/#/c/177533/

Christian.


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 04/25/2015 09:54 AM, Christian Berendt wrote:
I think we need to rework the whole content and should remove both
chapters from the installation guide for the moment.

https://review.openstack.org/#/c/177533/

Can we please decide how to proceed here? If we want to keep both
chapters we have to rework them prior to the Kilo release.

Christian.


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Questions on Service and project name conventions

Good morning

As a new member to the project , requesting comments or feedback from the
group on following :

  1. OpenStack dashboard or OpenStack Dashboard :

https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_project_names
suggests that we use horizon: OpenStack dashboard .

http://git.openstack.org/cgit/openstack/governance/tree/reference/projects.yaml
uses the capitalized service name, service: Dashboard . Should we use
OpenStack dashboard instead of OpenStack Dashboard? .

  1. do we need to update the previous release notes with new document
    conventions or do we consider them frozen ?

if the answer to the above question is yes ,what will be best approach to
address references to quantum : do we lower case Quantum or change
references to quantum to a different set of words

this is in reference to
https://bugs.launchpad.net/horizon/+bug/1446253
https://review.openstack.org/#/c/175045/

regards
Pratap.


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Good morning

As a new member to the project , requesting comments or feedback from the
group on following :

  1. OpenStack dashboard or OpenStack Dashboard :

https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_project_names
suggests
that we use horizon: OpenStack dashboard .

http://git.openstack.org/cgit/openstack/governance/tree/reference/projects.yaml
uses
the capitalized service name, service: Dashboard . Should we use
OpenStack dashboard instead of OpenStack Dashboard? .

  1. do we need to update the previous release notes with new document
    conventions or do we consider them frozen ?

if the answer to the above question is yes ,what will be best approach to
address references to quantum : do we lower case Quantum or change
references to quantum to a different set of words

this is in reference to
https://bugs.launchpad.net/horizon/+bug/1446253
https://review.openstack.org/#/c/175045/

regards
pratap


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [networking] Meeting minutes 4/24/15

Simple update today. Not much traction from the Neutron doc day so
we're trying to get things finished off. We decided to put in a
placeholder for the config section and update as appropriate.

Current statuses are here: https://etherpad.openstack.org/p/networking-guide

Next meeting next Friday at 1400 UTC.


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] API site versioning

Hi,

This isn't my patch, but I'm just pulling this on to the mailing list
since I saw it languishing: https://review.openstack.org/#/c/155329/ :)

In this patch, the sample json files are updated for new things that are
coming in Kilo. However, as Anne notes: "This site is updated
continually, but it seems like these JSON examples won't be accurate
until the next version comes out. What should we do in this case?"

Then it's noted that we have folks using trunk, etc.

So - API site versioning - how do we solve it for "all APIs and those
with extensions" ?

Regards,

Tom


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On Sun, Apr 26, 2015 at 7:24 PM, Tom Fifield tom@openstack.org wrote:

Hi,

This isn't my patch, but I'm just pulling this on to the mailing list
since I saw it languishing: https://review.openstack.org/#/c/155329/ :)

In this patch, the sample json files are updated for new things that are
coming in Kilo. However, as Anne notes: "This site is updated
continually, but it seems like these JSON examples won't be accurate
until the next version comes out. What should we do in this case?"

Then it's noted that we have folks using trunk, etc.

So - API site versioning - how do we solve it for "all APIs and those
with extensions" ?

This needs blueprint-level design decisions and a spec. Ideally we'll rid
ourselves of WADL in the design as well.

I'd like to take this on next release and I'm looking for collaborators.
Extensible APIs make versioning especially difficult.

Thanks,
Anne

Regards,

Tom


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] OpenStack Doc - New Contributor

Hello,

I am Ghezal, I'm a new contributor to OepnStack, and interested in working
on documentation. Please let me know what areas I can focus on.

Thank you,
Ghezal


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi Ghezal, and welcome!

The best place to start is probably just to jump in and find a bug that
interests you, assign yourself, and get going:
https://launchpad.net/openstack-manuals

Contributing to docs is just like contributing code, there are details here:
https://wiki.openstack.org/wiki/Documentation/HowTo

If you have any trouble getting started, or finding something to work
on, just let us know. You can email here, or find us on IRC in

openstack-doc on Freenode.

Cheers,
Lana

On 28/04/15 05:22, Ghezal Sherdil wrote:
Hello,

I am Ghezal, I'm a new contributor to OepnStack, and interested in working
on documentation. Please let me know what areas I can focus on.

Thank you,
Ghezal


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVPrRYAAoJELppzVb4+KUyGcwIAL+7FgwYx5iXR37NmjjiHSdq
tGPs3mj4e+IJbEtcZaYru1S8Re19/ajvi0o1vWrXq7K+2jcD1Wt3/XieW3nWBgIn
UNDSIuM8+ALaLA17czqcbnzAiiRz9URr+rFS/kjSjsyFAQMna6rntAt6IbtpRctv
WcezIXv+Q4yvEXR+ERkDAUPy1HFfR8wmULlTp5lh7dCAiLp0joAiwDDTmCDQ6yIU
DVGHf3jHPuXZ1KSXBjV0TbF56WYMembvqy2FZofMa8at0sRjod2wQapjAT1hhOdi
bOovRTa1olFv4/0F+k8zcDdOSngcxzow6yVbcGN3Is2Z3lnabpDzw4LqyYP+8YQ=
=zx+9
-----END PGP SIGNATURE-----


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Re: [OpenStack-docs] [training-guides] getting down to basics

Hi Sean,

  • create the architect guide based on TDD
    I strongly oppose this point. I cannot see architect benifiting from
    TDD.
  • public infra version of the trainer cluster
    This point is not clear.
  • integration of the trainer cluster into other docs
    I fail to see how this could be a spec?
    Regards,
    Pranav


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Roger,

I agree with you on this point! This usecase is not exactly useful, we might
want to reconsider a private cloud deployed on trainers laptop which is being
shared with the users who do not have machines good enough to run the cluster.

Regards,
Pranav

On Mon, 2014-12-01 at 10:26 +0100, Roger Luethi wrote:
On Sun, 30 Nov 2014 23:10:19 -0800, sean roberts wrote:

  • public infra version of the trainer cluster

We have already identified a number of issues that will likely limit
the
usefulness of such a version. The proposed spec has more information:

https://review.openstack.org/#/c/137299/

Before embarking on such an adventure, we would need good answers to
at
least these questions:

a) Is there a need for this? How many trainees have access to
hardware
that cannot run the training-cluster itself but can interact with
a
node VM in a public cloud?

b) Which features of the training cluster need to work in the public
infra version? Are the trainees just going to play with the
dashboard,
or will they have a shell in the node VM and expect to find the
exact environement of the training cluster?

  • integration of the trainer cluster into other docs

I don't understand what that means. Can you elaborate?

Roger


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] How to branch for Kilo?

Looking at:
https://review.openstack.org/#/c/174869/

How are we going to publish and branch for Kilo?

Should we do the same as in the past and publish current draft guides to
/kilo without branching for now?

Andreas
--
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, Jennifer Guild, Dilip Upmanyu,
Graham Norton, HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On Tue, Apr 28, 2015 at 4:51 AM, Andreas Jaeger aj@suse.com wrote:

Looking at:
https://review.openstack.org/#/c/174869/

How are we going to publish and branch for Kilo?

Should we do the same as in the past and publish current draft guides to
/kilo without branching for now?

Really depends on how the install guide is by Thursday. I think the Config
Ref is as good as it's going to get.

Hopefully we'll get an update to
https://wiki.openstack.org/wiki/KiloDocTesting so we can decide when to
create a stable/kilo branch. Install team, let us know after you meet this
week.
Thanks,
Anne

Andreas
--
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, Jennifer Guild, Dilip Upmanyu,
Graham Norton, HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Install guide team meeting

Sorry for not sending this out sooner-install guide team meeting is now:

https://plus.google.com/hangouts/_/calendar/a2FyaW4ua2F0aG9kZUBnbWFpbC5jb20.jj2lu2nbj71a0dan11vatdav3k

On the agenda:
Status updates for Kilo
Are we ready to branch?


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [install guide] Team meeting 28 April 2015

Attendees: Christian Berendt, Tom Fifield, Karin Levenstein

Current bug status: https://bugs.launchpad.net/openstack-manuals/+bugs?field.tag=install-guide

Ubuntu: Tom has run into an issue testing the guide due to rabbitmq.com connectivity issues - https://bugs.launchpad.net/openstack-manuals/+bug/1449339. The good news is their team is very responsive and trying to help.

CentOS/RHEL: In good shape. Christian reports a small issue with Keystone service, not a real blocker, have a working keystone setup. Per discussion on list, Sahara content will not be included until we have a chance to rework them.

SUSE: Christian reports that it's not ready yet, but there should be progress over the next few days. Andreas and Pranav will work on it, and Christian will try and handle reviews as they come in over the weekend, with a goal to have SUSE work completed and ready for testing by the beginning of next week. (Christian will be available to test on Thursday.)


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Re: [OpenStack-docs] Improving OpenStack documentation around RabbitMQ

On 04/28/2015 02:59 PM, Michael Klishin wrote:

I'm a RabbitMQ engineering team member and we'd like to help improve OpenStack docs
around it.

Welcome :)

I've been reading the docs and making notes of what can be improved. We'd be happy
to contribute the changes. However, we're not very familiar with the OpenStack development
process and have a few questions before we start.

The entry point for documentation is
https://wiki.openstack.org/wiki/Documentation/HowTo. We will discuss in
Vancouver on the summit how to improve the experience for newcomers to
the documentation.

As far as I understand, OpenStack Kilo is about to ship. Does this mean we can only contribute
documentation improvements for the release after it? Are there maintenance releases that doc improvements
could go into? If so, how is this reflected in repository branches?

In a few days there will be a stable/kilo branch. It is possible to
backport changes from the current state of the repository to the stable
branches. We do not have to wait for the regular maintaince release to
publish changes there.

Should the changes we propose be discussed on this list or in GitHub issues [1]?

On this list or on launchpad. We do not use the Github issues.

https://launchpad.net/openstack-manuals

Finally, we are considering adding a doc guide dedicated to OpenStack on rabbitmq.com (we have one for EC2,
for instance). Note that we are not looking
to replace what's on docs.openstack.org, only provide a guide that can go into more details.
Does this sound like a good idea to the OpenStack community? Should we keep everything on docs.openstack.org?
Would it be OK if we link to rabbitmq.com guides in any changes we contribute? I don't think OpenStack Juno
docs have a lot of external links: is that by design?

I think it depends. It would be nice to have a working minimal guide for
RabbitMQ inside the OpenStack documentation (as used at the moment in
the installation guides).

Do you mean this EC2 guide: http://www.rabbitmq.com/ec2.html ? I think
such guides should be directly published on rabbitmq.com. I can assist
while writing a guide for OpenStack.

Christian.

--
Christian Berendt
Cloud Computing Solution Architect
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On Tue, Apr 28, 2015 at 9:01 AM, Christian Berendt christian@berendt.io
wrote:

On 04/28/2015 02:59 PM, Michael Klishin wrote:

I'm a RabbitMQ engineering team member and we'd like to help improve
OpenStack docs
around it.

Welcome :)

I've been reading the docs and making notes of what can be improved.
We'd be happy
to contribute the changes. However, we're not very familiar with the
OpenStack development
process and have a few questions before we start.

The entry point for documentation is
https://wiki.openstack.org/wiki/Documentation/HowTo. We will discuss in
Vancouver on the summit how to improve the experience for newcomers to
the documentation.

As far as I understand, OpenStack Kilo is about to ship. Does this mean
we can only contribute
documentation improvements for the release after it? Are there
maintenance releases that doc improvements
could go into? If so, how is this reflected in repository branches?

In a few days there will be a stable/kilo branch. It is possible to
backport changes from the current state of the repository to the stable
branches. We do not have to wait for the regular maintaince release to
publish changes there.

All true, but specifically the ha-guide is in a separate repo and does not
have any stable branches. It is continuously released, so you need to write
in mind that operators could be approaching it from any of the three
releases available to them. https://wiki.openstack.org/wiki/Releases

Should the changes we propose be discussed on this list or in GitHub
issues [1]?

On this list or on launchpad. We do not use the Github issues.

https://launchpad.net/openstack-manuals

Finally, we are considering adding a doc guide dedicated to OpenStack on
rabbitmq.com (we have one for EC2,
for instance). Note that we are not looking
to replace what's on docs.openstack.org, only provide a guide that can
go into more details.
Does this sound like a good idea to the OpenStack community? Should we
keep everything on docs.openstack.org?
Would it be OK if we link to rabbitmq.com guides in any changes we
contribute? I don't think OpenStack Juno
docs have a lot of external links: is that by design?

I think it depends. It would be nice to have a working minimal guide for
RabbitMQ inside the OpenStack documentation (as used at the moment in
the installation guides).

Do you mean this EC2 guide: http://www.rabbitmq.com/ec2.html ? I think
such guides should be directly published on rabbitmq.com. I can assist
while writing a guide for OpenStack.

I agree, we need to be extremely careful with what we can take on in the
upstream docs, we are severely resource constrained. Can I use extreme and
severe more? Probably, but want to emphasize we don't really take on more
than we need to in upstream central docs team. We definitely want the write
ups, but the judgement comes in where it's published. Lana's the PTL for
Liberty so she can evaluate.

Anne

Christian.

--
Christian Berendt
Cloud Computing Solution Architect
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] DocTeam meeting times for April 29th

Good afternoon ,

I am interested in attending the next weekly DocTeam meeting on IRC. I
was wondering what time the meeting would take place on 4/29/15.
Tomorrow will be the fifth Wednesday of April, and the current meeting
schedule does not address this issue.

Thanks,
Michael


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 29/04/15 07:55, Michael Simo wrote:
Good afternoon ,

I am interested in attending the next weekly DocTeam meeting on IRC. I
was wondering what time the meeting would take place on 4/29/15.
Tomorrow will be the fifth Wednesday of April, and the current meeting
schedule does not address this issue.

Hi Michael,

Thanks for your interest! We're moving to an alternating meeting time
instead of the 1/3 and 2/4 system we had previously. I'll update the
page accordingly.

Today, the meeting is in the APAC timezone, at 0100 UTC (about 45
minutes from now). Next week, on 6 May, it will be in the US timezone,
at 1400 UTC.

Hope that helps.

Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVQBTFAAoJELppzVb4+KUyfrIIAI+j85Miohmdee6YMf5PHdS9
vwxka8Z77Noxp5deMNopiRsR5/q6rzhmXu7ypfBXLRBXWvR+cgA6tMl8ZKQMdIi6
byi0SBOBe2mKoR3o1xlv8QrjjHzSBi2cjaV4dumgn7Vkq6Kp2tSoksV6wGBfEkSB
6OXqXdgjYBXwLdLwTrelEqiFEj7YerEm+VMwou7WjVjXf2nzR6dSnSengMMGknw4
I+wV5bx/37Xqe0XSD+RS0ussFnTlcgLtVOP/THSP7ORuXExKfw0pupJuJTkKhHxb
8iXxQUtkHl2jRfm/TlB1GKY140+ufwJMHbq6PORP6vPfxSt9dWm6feRBrBD6+0E=
=drki
-----END PGP SIGNATURE-----


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Autogenerate the API Reference

Hi all,

I'm writing to you because I think we should seriously consider
generating the API reference at least partially from the code itself,
rather than continuing to maintain a separate set of documents that has
no relationship with the code.

No-one can argue that it's an enormous amount of work to maintain an API
reference. Despite our best efforts, our API reference is incomplete and
inaccurate - you need only check the bug list[1] to know this.

The move to swagger[2] will help some of this, but it's not enough. Even
with new tooling, we are still stuck in a world of manual updates and
effort - spending a large amount of time converting a python
method/class definition into another format.

We do add great value in the descriptions of parameters, groupings and
overall display of the information. Diane is simply amazing here. So,
wouldn't it be great if we could focus just on that, without needing to
worry about changing this python docstring:

"""
Move your app forward with the Uber API
"""

into this swagger description:

info:
description: Move your app forward with the Uber API

and instead fix up the string itself ?

The move-to-swagger spec at the moment says: "We don't really want
autogenerated API documentation, because then how do you know if the
code is correct?". Which is really quite odd - because looking at the
code is exactly what developers, SDK makers and users are doing right
now when confronted with our incomplete, inaccurate documentation :) The
code is what defines the API - it's what actually processes the requests
and responses. If there's a problem where the implementation of that
processing is incorrect - we fix that in the code, not by telling users
something completely different in a document :)

We may yet get to the point where OpenStack APIs are
designed-in-document first, then implemented, but we're far from that at
the moment and have much more pressing problems to solve.

There are a number of python integrations that swagger supports[3].
Essentially, what these would allow us to do is use portions of the code
to generate swagger specs. This means that our documentation would
always be complete and accurate to what users actually experience when
they interact with OpenStack APIs.

The automation of option tables in the configuration reference is a good
parallel here. We used to have very incomplete and often outdated
configuration tables. After the automation, literally hundreds of bugs
have been solved with very little human intervention. The problem just
doesn't exist anymore, and we've clawed back some of our precious resources.

In the config-ref there are two types of auto-magic: non-swift, where
all text lives in the code and updates should be done there; and swift,
where the option name comes from the code, but the descriptive text must
be manually entered - overwriting a default label of "No help text
available for this option".

Applying that to API documents, I think it would be amazing to try the
former: it basically means that developers write their own API
documentation, happily, in the code, in a format they are familiar with.
We can take that and generate swagger for the API-ref and display it
appropriately.

However, that might not be possible, or might be too much work for a
single release. So, the second option is still a very good one - we use
automation to extract some information (eg it could be just class
titles, doc strings, parameter names) to generate swagger specs with the
placeholder text that we-as-the-docs-team can fill in with our best
efforts - which are excellent, since we're the pros at strings :)

The important thing is that this should be done continuously[4], as with
the config-ref, to ensure accuracy and completeness. Just looking at the
first 75 bugs in api-site[5], this approach would solve almost all of
them. This isn't something you can say about simply switching formats ;)

Anyway, thank you if you've managed to get to this point. I think we
have a great opportunity here to make a very significant change to the
way we do API documentation, and free up our previous docs resources to
really focus on the things we do best, rather than spending a lot of
time changing one arcane syntax into another :)

Regards,

Tom

[1] https://bugs.launchpad.net/openstack-api-site
[2] https://review.openstack.org/#/c/177934/
[3] https://github.com/swagger-api/swagger-spec#python , I found there's
a worked example showing the output of the swagger UI for
django-rest-swagger at:
http://django-rest-swagger.readthedocs.org/en/latest/examples.html
[4] Kinda once a milestone is how we're doing it with config-ref at the
moment, but this could in theory be fully automated
[5] https://bugs.launchpad.net/openstack-api-site/+bugs?orderby=id&start=0

-------- Forwarded Message --------
Subject: [Blueprint autogenerate-api-reference] Autogenerate API Reference
Date: Mon, 27 Apr 2015 15:14:41 -0000
From: Anne Gentle anne@openstack.org
Reply-To: Anne Gentle anne@openstack.org
To: tom@openstack.org

Blueprint changed by Anne Gentle:

Whiteboard set to:
We don't really want autogenerated API documentation, because then how
do you know if the code is correct? How can a quality engineer or SDK
dev trust the output? Autogeneration is fine for the first set of docs
but after that need to be treated as the "contract" for SDK developers
to trust.

--
Autogenerate API Reference
https://blueprints.launchpad.net/openstack-manuals/+spec/autogenerate-api-reference


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

hi all, i missed the original email due to not being on this list so i'm
going to copy-paste and quote inline.

firstly, thanks for bringing this up Tom.

I'm writing to you because I think we should seriously consider
generating the API reference at least partially from the code itself,
rather than continuing to maintain a separate set of documents that has
no relationship with the code.

i agree, i think it would be great if projects could start from an
autogenerated base for their api-ref.

No-one can argue that it's an enormous amount of work to maintain an API
reference. Despite our best efforts, our API reference is incomplete and
inaccurate - you need only check the bug list[1] to know this.

The move to swagger[2] will help some of this, but it's not enough. Even
with new tooling, we are still stuck in a world of manual updates and
effort - spending a large amount of time converting a python
method/class definition into another format.

i'd love to see the density of workload shift slightly more on to the
project teams for the api-ref doc side of things. maybe it will help
ease some of the manual updating pressure on the doc team.

the sahara team recently did their api-ref wadls and i know it was a
hard fought battle with several of us participating. also big props to
Diane for helping us through that process.

We do add great value in the descriptions of parameters, groupings and
overall display of the information. Diane is simply amazing here. So,
wouldn't it be great if we could focus just on that, without needing to
worry about changing this python docstring:

"""
Move your app forward with the Uber API
"""

into this swagger description:

info:
description: Move your app forward with the Uber API

and instead fix up the string itself ?

i'm a big fan of increasing the usability of the docstrings to become
more informative. i realize this might be a slightly selfish desire as i
enjoy seeing them in the code, but i think it could pay off well if we
were to harvest the documentation to create something useful for users.

i would love to see some sort of oslo-ish package that would allow us to
have a neutral format in the docstrings that could then be transformed
into swagger or another format if necessary.

The move-to-swagger spec at the moment says: "We don't really want
autogenerated API documentation, because then how do you know if the
code is correct?". Which is really quite odd - because looking at the
code is exactly what developers, SDK makers and users are doing right
now when confronted with our incomplete, inaccurate documentation :) The
code is what defines the API - it's what actually processes the requests
and responses. If there's a problem where the implementation of that
processing is incorrect - we fix that in the code, not by telling users
something completely different in a document :)

+1, improving documentation in the code is a noble effort =)

We may yet get to the point where OpenStack APIs are
designed-in-document first, then implemented, but we're far from that at
the moment and have much more pressing problems to solve.

i'm completely intrigued by this process and i love what swagger is
proposing/doing in this problem space. i'm unsure that we would ever
reach this point with openstack projects but i think it would provide
interesting options for new projects if we had some sort of path for
this type of development.

i can imagine a world where a new project is able to get their wsgi
server/api up and running quickly by defining a nice swagger doc that
would transform into a code skeleton. imo, this would rock. it wouldn't
be a one-stop-shop solution, but a nice solid toolkit to start from.

There are a number of python integrations that swagger supports[3].
Essentially, what these would allow us to do is use portions of the code
to generate swagger specs. This means that our documentation would
always be complete and accurate to what users actually experience when
they interact with OpenStack APIs.

assuming we had the extra markup to make complete swagger docs it would
always be up to date. i think the sticking point is getting to the level
where the autogenerated output contains all the necessary information.

i think it would a great first step to have projects creating the
baseline for their docs from an autogenerated format, then marking up as
necessary. hopefully backporting the added information into their code,
or just improving it to begin with.

The automation of option tables in the configuration reference is a good
parallel here. We used to have very incomplete and often outdated
configuration tables. After the automation, literally hundreds of bugs
have been solved with very little human intervention. The problem just
doesn't exist anymore, and we've clawed back some of our precious resources.

In the config-ref there are two types of auto-magic: non-swift, where
all text lives in the code and updates should be done there; and swift,
where the option name comes from the code, but the descriptive text must
be manually entered - overwriting a default label of "No help text
available for this option".

Applying that to API documents, I think it would be amazing to try the
former: it basically means that developers write their own API
documentation, happily, in the code, in a format they are familiar with.
We can take that and generate swagger for the API-ref and display it
appropriately.

+1

i'd like to take it a step further and say that the projects themselves
could be responsible for creating the swagger and then the upstream
api-ref could grab those documents for aggregation into the doc team
managed site. this will make more work for the project teams, but i like
the idea of allowing the teams to have more control over their api output.

this might make it more difficult for the doc team to organize
consistency as they might have to reach back to the project teams if
there are issues with their generated docs, and i don't really have a
good answer for that at this point. perhaps this could be an area where
the team liaisons could help?

However, that might not be possible, or might be too much work for a
single release. So, the second option is still a very good one - we use
automation to extract some information (eg it could be just class
titles, doc strings, parameter names) to generate swagger specs with the
placeholder text that we-as-the-docs-team can fill in with our best
efforts - which are excellent, since we're the pros at strings :)

+1, this would be an awesome starting point

The important thing is that this should be done continuously[4], as with
the config-ref, to ensure accuracy and completeness. Just looking at the
first 75 bugs in api-site[5], this approach would solve almost all of
them. This isn't something you can say about simply switching formats ;)

Anyway, thank you if you've managed to get to this point. I think we
have a great opportunity here to make a very significant change to the
way we do API documentation, and free up our previous docs resources to
really focus on the things we do best, rather than spending a lot of
time changing one arcane syntax into another :)

i agree, i find the prospect of this really encouraging =)

mike

Regards,

Tom

[1] https://bugs.launchpad.net/openstack-api-site
[2] https://review.openstack.org/#/c/177934/
[3] https://github.com/swagger-api/swagger-spec#python , I found there's
a worked example showing the output of the swagger UI for
django-rest-swagger at:
http://django-rest-swagger.readthedocs.org/en/latest/examples.html
[4] Kinda once a milestone is how we're doing it with config-ref at the
moment, but this could in theory be fully automated
[5] https://bugs.launchpad.net/openstack-api-site/+bugs?orderby=id&start=0

-------- Forwarded Message --------
Subject: [Blueprint autogenerate-api-reference] Autogenerate API Reference
Date: Mon, 27 Apr 2015 15:14:41 -0000
From: Anne Gentle
Reply-To: Anne Gentle
To: tom at openstack.org

Blueprint changed by Anne Gentle:

Whiteboard set to:
We don't really want autogenerated API documentation, because then how
do you know if the code is correct? How can a quality engineer or SDK
dev trust the output? Autogeneration is fine for the first set of docs
but after that need to be treated as the "contract" for SDK developers
to trust.

--
Autogenerate API Reference
https://blueprints.launchpad.net/openstack-manuals/+spec/autogenerate-api-reference


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] URGENT: Getting ready for Kilo

I've written up what needs to be done for the release of Kilo on an
Etherpad for better coordination:

https://etherpad.openstack.org/p/kilo-docs

Looking at the discussion on the mailing list, I propose we do the
following:

As in the past, we publish from master for now, we will branch a
separate kilo branch later.

We have to do the following high-level tasks:

  • Publish Networking Guide continously
  • Publish Install Guides to /kilo
  • Publish Configuration Reference to /kilo
  • Update guides for kilo release
  • Update web page for kilo release

Please review the patches referenced in the wiki with high priority,
create patches that are missing and sign up for tasks.

I'd like to have everything done today - if possible - so that we have
no last minute bugs to chase,

Andreas
--
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, Jennifer Guild, Dilip Upmanyu,
Graham Norton, HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On Wed, Apr 29, 2015 at 1:50 AM, Andreas Jaeger aj@suse.com wrote:

I've written up what needs to be done for the release of Kilo on an
Etherpad for better coordination:

https://etherpad.openstack.org/p/kilo-docs

Looking at the discussion on the mailing list, I propose we do the
following:

As in the past, we publish from master for now, we will branch a separate
kilo branch later.

We have to do the following high-level tasks:

  • Publish Networking Guide continously
  • Publish Install Guides to /kilo
  • Publish Configuration Reference to /kilo
  • Update guides for kilo release
  • Update web page for kilo release

Please review the patches referenced in the wiki with high priority,
create patches that are missing and sign up for tasks.

Thanks Andreas for organizing the charge! I reviewed our
Documentation/Release wiki page and was planning to do some of these
patches today but you all are ahead, that's fantastic. Thank you Christian
and Tom for jumping in on patches.
Anne

I'd like to have everything done today - if possible - so that we have no
last minute bugs to chase,

Andreas
--
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, Jennifer Guild, Dilip Upmanyu,
Graham Norton, HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Liberty Design Summit Sessions

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi everyone,

With the Kilo release now pretty much complete (thanks Anne and Andreas,
and everyone who pitched in to make that happen!) it's time to start
planning Liberty.

Thanks to all the great design summit suggestions over the past couple
of weeks, I've managed to put together what I hope is going to be an
interesting (and jam packed) design summit for our next release. You can
see the schedule on Sched here:

http://libertydesignsummit.sched.org/type/design+summit/Documentation

Feedback and questions are, as always, very welcome :)

Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVQZzeAAoJELppzVb4+KUypWwIANIYtFvgePs85zJu7xeTynRh
E0dVgNL789+BOm8B/D6UakVM8a1jPyq4sd8ru4AeE6+gOYt63UCjFoZ7KHBUCWou
OjSDVlcncLfsZFZLMvX0Fa9VhOHknjlTMavSja8o36rpuNroGIAllZg5KuKJcX4i
iBnvTeh6qpTKtntscSwZpuM7srAoJoVPs0qdURKpMgqhYaduG7PlV84rUjSXBQTn
G+IBS4La7o6lx3L1Gl+zS6u40DqrbsqGxgPd518G1wnbcWoe4nYTk0/kdAi7Y/oM
upgCO+QUgR7mySVGw4P99t83JjToJe/KrTH4fLEo8kbLOPxPKkKamR9TeVkcJTE=
=Q5Lj
-----END PGP SIGNATURE-----


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi everyone,

Good news! We scored an extra fishbowl session on Wednesday afternoon!
I've rejiggered the schedule, and split the Information Architecture
fishbowl into two, which will hopefully mean we can have a more
meaningful conversation on that topic. This means the RST conversion
conversation is now a day earlier, on Wednesday at 13:50.

Check out the changes here:
http://libertydesignsummit.sched.org/type/design+summit/Documentation

Feedback welcome :)

Lana

On 30/04/15 13:09, Lana Brindley wrote:
Hi everyone,

With the Kilo release now pretty much complete (thanks Anne and Andreas,
and everyone who pitched in to make that happen!) it's time to start
planning Liberty.

Thanks to all the great design summit suggestions over the past couple
of weeks, I've managed to put together what I hope is going to be an
interesting (and jam packed) design summit for our next release. You can
see the schedule on Sched here:

http://libertydesignsummit.sched.org/type/design+summit/Documentation

Feedback and questions are, as always, very welcome :)

Lana


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVTrCuAAoJELppzVb4+KUySi0H/0/8gsDnqA8l+P956RMaCMOu
qu4tHpvYZDtLw02xdlOQo2C/7hohvI76fPTOiZRtJ+9FKcZhNuyOzK2J43vgPe2N
31tESJn4ABtbHa+40La6PA8brMUm/FmPHtnzzyTsoJ1UtPEmOcGBrKSGpqM+VCKf
th4QwEwTC04cmKLkslraCzr+NLwExSEDHtC/yxZYcgvaJlUi6+i6ftUerq3K9HQE
c4qrPwTeBGh3xGvtqA8pV4EegOFLMCCWEe9hfoo/TuHEXFT9jBaHh5etydfeEtRi
nAzX/6VYwoHNmHk+OYQ74MCRPxsi2ILcsAuRpV/7oD0Pw8/Oe5ZrJobpDmuZ2Kw=
=l5hn
-----END PGP SIGNATURE-----


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] conventions: service and project names

At the moment we reference to
https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_project_names
if we are talking about the official project names and capitalization.

I want to discuss the removal of this list.

The list should be replaced by a note referencing the "service"
parameter of the
https://github.com/openstack/governance/blob/master/reference/projects.yaml
file.

For example the official project name and capitalization of the project
"Nova" is "Compute", for "Sahara" it is "Data processing service".

Christian.

--
Christian Berendt
Cloud Solution Architect
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 04/30/2015 12:37 PM, Christian Berendt wrote:
At the moment we reference to
https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_project_names
if we are talking about the official project names and capitalization.

I want to discuss the removal of this list.

The list should be replaced by a note referencing the "service"
parameter of the
https://github.com/openstack/governance/blob/master/reference/projects.yaml
file.

For example the official project name and capitalization of the project
"Nova" is "Compute", for "Sahara" it is "Data processing service".

Christian.

The wiki page already has a reference:

"The official source for names is in the OpenStack governance repo in
the projects.yaml file. " with a link to the file.

And there should not be any conflict, or is there one?

I'm fine with the duplication to make it clear what we use,
Andreas
--
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, Jennifer Guild, Dilip Upmanyu,
Graham Norton, HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [ha-guide] meeting today

Hi HA Guide team,

Unfortunately I have a conflict and cannot make the meeting today.
See you next week.

Best,
Matt


Matt Griffin
Director of Product Management
Percona
irc: mattgriffin
skype: thebear78
m: 1-214-727-4100

OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

I have a conflict as well. Quick update, maybe we can save some time:

1) Anne created a spec and it's wending its way through the approval
process. Meg has been tweaking.
2) Several SMEs are working on topics based on the TOC. Drafts due in 5/4.

---- Nick

On 4/30/2015 2:33 PM, Matt Griffin wrote:
Hi HA Guide team,

Unfortunately I have a conflict and cannot make the meeting today.
See you next week.

Best,
Matt


Matt Griffin
Director of Product Management
Percona
irc: mattgriffin
skype: thebear78
m: 1-214-727-4100


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [networking] Meeting change

Schedule conflicts are preventing our normal Friday meeting, but we're
afraid to postpone a whole week, as we need to get the framework of the
presentation together. We propose to move to sometime Tuesday, say,
11am Pacific?

---- Nick


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Did we settle on 11 pacific or can we do 10?

On Thu, Apr 30, 2015 at 3:46 PM, Nick Chase nchase@mirantis.com wrote:

Schedule conflicts are preventing our normal Friday meeting, but we're
afraid to postpone a whole week, as we need to get the framework of the
presentation together. We propose to move to sometime Tuesday, say, 11am
Pacific?

---- Nick


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] What's Up Doc? Apr 30, 2015

It has been an honor to work with all of you and I'm so excited the Kilo
release is complete! Many thanks for the hours and hard-earned knowledge
that you put into words for others to benefit. OpenStack is better for each
and every one of you. I've been meeting with Lana at least weekly to make
the transition smooth, and know I will continue to collaborate with this
amazing docs community. Thank you all for allowing me to serve.

Here are the minutes from this week's Doc Team meeting:
http://eavesdrop.openstack.org/meetings/docteam/2015/docteam.2015-04-29-01.00.html

Please review both the Liberty Design Summit schedule:

http://libertydesignsummit.sched.org/type/design+summit/Documentation

And the specs that are in review to prepare for the Liberty release
planning:

https://review.openstack.org/#/q/status:open+project:openstack/docs-specs,n,z

Also, we need someone to run the US-based timezone doc team meetings.
Please let Lana know you're interested. We'll give amazing IRC meeting
training to the first person to volunteer.

Thanks,
Anne

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

I am interested in leading the U.S. Docs irc meetings!

Sent from my iPhone

On Apr 30, 2015, at 5:31 PM, Anne Gentle annegentle@justwriteclick.com wrote:

It has been an honor to work with all of you and I'm so excited the Kilo release is complete! Many thanks for the hours and hard-earned knowledge that you put into words for others to benefit. OpenStack is better for each and every one of you. I've been meeting with Lana at least weekly to make the transition smooth, and know I will continue to collaborate with this amazing docs community. Thank you all for allowing me to serve.

Here are the minutes from this week's Doc Team meeting: http://eavesdrop.openstack.org/meetings/docteam/2015/docteam.2015-04-29-01.00.html

Please review both the Liberty Design Summit schedule:

http://libertydesignsummit.sched.org/type/design+summit/Documentation

And the specs that are in review to prepare for the Liberty release planning:

https://review.openstack.org/#/q/status:open+project:openstack/docs-specs,n,z

Also, we need someone to run the US-based timezone doc team meetings. Please let Lana know you're interested. We'll give amazing IRC meeting training to the first person to volunteer.

Thanks,
Anne

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [install-guides] mariadb/mysql for opensuse

Hello,

I was going through the drafts for Kilo and realized that as per the given
section under the mariadb section:
http://docs.openstack.org/draft/install-guide/install/zypper/content/ch_basic_environment.html#basics-networking

I do not get the required results by editing the following configuration
file: /etc/my.cnf.d/mariadb_openstack.cnf

What works for me is /etc/my.cnf as per the traditional method. Does
someone know why this has been changed?

Regards,
Pranav


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 05/01/2015 05:10 PM, Pranav Salunke wrote:
I do not get the required results by editing the following configuration
file: |/etc/my.cnf.d/mariadb_openstack.cnf|

What works for me is /etc/my.cnf as per the traditional method. Does
someone know why this has been changed?

This was changed with https://review.openstack.org/#/c/172635.

It was changed because of: "Where available, use the /etc/mysql/conf.d
directory for additional database configuration."

If this is not working for SUSE based distributions with have to revert
the change in line 37
(https://review.openstack.org/#/c/172635/3/doc/install-guide/section_basics-database.xml).

Christian.

--
Christian Berendt
Cloud Solution Architect
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Qeustions about openstack-auto-commands

I am reworking openstack-auto-commands at the moment and have a few
questions.

  1. Why do we blacklist several commands?

At least it should be documented why we blacklisted the following commands:

Ceilometer:

https://github.com/openstack/openstack-doc-tools/blob/master/os_doc_tools/commands.py#L544

Heat:

https://github.com/openstack/openstack-doc-tools/blob/master/os_doc_tools/commands.py#L554-L556

Nova;

https://github.com/openstack/openstack-doc-tools/blob/master/os_doc_tools/commands.py#L569

Trove:

https://github.com/openstack/openstack-doc-tools/blob/master/os_doc_tools/commands.py#L583

  1. Why do we document trove-manage
    (https://github.com/openstack/openstack-doc-tools/blob/master/os_doc_tools/commands.py#L584-L591)
    but not nova-manage or glance-manage?

Christian.

--
Christian Berendt
Cloud Solution Architect
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 05/01/2015 05:30 PM, Christian Berendt wrote:
I am reworking openstack-auto-commands at the moment and have a few
questions.

  1. Why do we blacklist several commands?

At least it should be documented why we blacklisted the following commands:

Ceilometer:

https://github.com/openstack/openstack-doc-tools/blob/master/os_doc_tools/commands.py#L544

the command is deprecated, run it with help and check the output.

I didn't check all of them but AFAIR all are deprecated and there are
replacements for them.

Care to send a patch after double checking?

  1. Why do we document trove-manage
    (https://github.com/openstack/openstack-doc-tools/blob/master/os_doc_tools/commands.py#L584-L591)
    but not nova-manage or glance-manage?

Nobody saw the need for it and implemented it,

Andreas
--
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, Jennifer Guild, Dilip Upmanyu,
Graham Norton, HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [User Guides] Team Meeting for 01/05/15

Hello All,

Attendees: Lana Brindley, Alex Settle, Deepti Navale, Darren Chan, Brian Moss, Joseph Robinson

Document Spec: We have a documentation spec currently under review - any additions to the spec to improve the User Guide Information Architecture are welcome. The Spec is the first for Liberty, and is currently WIP until all additions are in place. https://review.openstack.org/#/c/174647/

Blueprints: The Blueprint remains current. https://blueprints.launchpad.net/openstack-manuals/+spec/reorganise-user-guides

Meeting Management: The user-guide specialty team has new managers. Joseph and Brian will be co-managing the meeting, starting this Friday May 8th, 2015.

Best Regards,

Joseph Robinson
Information Developer I


+61 2 9276 3896
+61 424 970 728


Rackspace Hosting Australia PTY LTD a company registered in the state of Victoria, Australia (company registered number ACN 153 275 524) whose registered office is at Level 1, 37 Pitt Street, Sydney, NSW 2000, Australia. Rackspace Hosting Australia PTY LTD privacy policy can be viewed at www.rackspace.com.au/company/legal-privacy-statement.php - This e-mail message may contain confidential or privileged information intended for the recipient. Any dissemination, distribution or copying of the enclosed material is prohibited. If you receive this transmission in error, please notify us immediately by e-mail at abuse@rackspace.com and delete the original message. Your cooperation is appreciated.

OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Development visualization with Gource

I played with Gource (https://github.com/acaudwell/Gource), a tool to
visualize the evolution of a repository, and published the results on
YouTube:

openstack-doc-tools development visualization:
https://www.youtube.com/watch?v=uYGNSufgwC4

openstack-manuals development visualization:
https://www.youtube.com/watch?v=42kUhohO7B0

Christian

--
Christian Berendt
Cloud Solution Architect
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] "logical" vs "conceptual" architecture of Openstack - what does it mean?

The admin guide has two pages showing the conceptual[1] and the logical[2]
architecture of OpenStack. I don't understand the difference between the
two; the diagrams on the two pages both show the core services; the
difference is that the "logical" diagram is much more detailed.

Can anybody provide insight what this distinction "logical/conceptual" is
supposed to mean? I am asking because I plan to rewrite the text on the
"logical" page.

Bernd

[1]
http://docs.openstack.org/admin-guide-cloud/content/conceptual-architecture.
html
[2]
http://docs.openstack.org/admin-guide-cloud/content/logical-architecture.htm
l


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 05/04/2015 01:53 PM, Bernd Bausch wrote:
Can anybody provide insight what this distinction "logical/conceptual" is
supposed to mean? I am asking because I plan to rewrite the text on the
"logical" page.

In my understanding conceptual is the top view and logical is the bottom
view.

Conceptual only shows the components as a black box (Neutron for
networking, Nova for compute, ..).

Logical shows the comonents as a white box.

Btw. the logcial architecture graphic should be reworked. Would be nice
to use the same style like for the conceptual architecture graphic there.

Christian.

--
Christian Berendt
Cloud Computing Solution Architect
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [training-guides] i am conflicted again

please run the meeting in my absence. I posted a few reviews. i plan on
pushing the outstanding patches in review this week.

~ sean


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Keep the sitemap.xml file outside of the openstack-manuals repository

Is it possible to keep the sitemap.xml file outside of the
openstack-manuals repository? I think it is useful to update the file
more often (daily) but I think we do not need to have older versions in
git. The file is rather big (2 MByte) and the diffs are pretty big
because of the changed timestamps.

Christian.

--
Christian Berendt
Cloud Computing Solution Architect
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On Tue, May 5, 2015 at 4:58 AM, Christian Berendt christian@berendt.io
wrote:

Is it possible to keep the sitemap.xml file outside of the
openstack-manuals repository? I think it is useful to update the file
more often (daily) but I think we do not need to have older versions in
git. The file is rather big (2 MByte) and the diffs are pretty big
because of the changed timestamps.

I'd like to see this, especially to have it changed daily. Maybe keep it in
openstack-doc-tools where it's generated and run a scheduled job to have it
updated automatically?

Christian.

--
Christian Berendt
Cloud Computing Solution Architect
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [install guide] Team update 5 May

No meeting today, but here's a list of things up for next week's agenda-consider this advance notice to think about these things and come ready to discuss:

Testing the current guide draft against official packages when they become available
Install Guide RST conversion
Ideas/plans for moving forward with Debian

Thanks,
Karin

--
Karin K. Levenstein
Team lead, RPC Docs US
https://rax.io/rpcdocs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [api] API reference - follow-up questions

Hi all,

For Liberty I am working on a specification to update the way we deliver
application developer information. [1] I'm incorporating Tom's suggestion
to automate API reference information. [2]

In revising the API reference specification I wanted to ask a few more
questions to shape the spec further.

  • Should we do a proof of concept for say, Compute, then have the other
    projects
    follow? Identity v3 has the most calls in the core with 74, but Compute v2
    plus
    extensions has over 120 calls. Alternatively, we could also limit the scope
    to "greater than 50% reported on User Survey [2]".

  • Is there any way to know what versions of an API a user answering the
    survey is running or do we have to scope to both versions for some of these
    services?
    Identity
    Compute
    Block Storage
    Image
    Networking

  • Do we continue to enable the project teams to indicate where they want to
    maintain REST API information? Or does this spec require particulars down
    to the folder name in the repo due to automation efforts?

Feel free to reply here or in the spec itself.

Thanks,
Anne

  1. https://review.openstack.org/#/c/177934/1

  2. http://lists.openstack.org/pipermail/openstack-docs/2015-April/006502.html

  3. http://superuser.openstack.org/articles/openstack-user-survey-insights-november-2014

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 05/05/2015 06:16 PM, Anne Gentle wrote:
* Should we do a proof of concept for say, Compute, then have the other
projects follow?

I would prefer to do a proof of concept first.

  • Do we continue to enable the project teams to indicate where they want
    to maintain REST API information? Or does this spec require particulars
    down to the folder name in the repo due to automation efforts?

I think it will simplify our life (and automation) if we dictate the
structure for the project repository.

Christian.

--
Christian Berendt
Cloud Solution Architect
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Fwd: [openstack-dev] [Fuel] Swagger documentation

An example of swagger-in-code here, from the Fuel team:

https://review.openstack.org/#/c/179051/

-------- Forwarded Message --------
Subject: [openstack-dev] [Fuel] Swagger documentation
Date: Wed, 06 May 2015 07:49:44 +0200
From: Przemyslaw Kaminski pkaminski@mirantis.com
Reply-To: OpenStack Development Mailing List (not for usage questions)
openstack-dev@lists.openstack.org
To: OpenStack Development Mailing List (not for usage questions)
openstack-dev@lists.openstack.org

Hello,

I prepared a small PoC of Swagger [1] as a proposal to [2]. If you want
to test it out, checkout that commit into your repo, start Nailgun
locally and point your browser to [3]. Basically you just need to put
Swagger-UI [4] somewhere and point your browser to /dist/index.html
there, filling in the URL. OPTIONS handler with appropriate CORS
settings is required on API side if Swagger UI's host is somewhere else
than the API. I've turned this on when the settings.DEVELOPMENT variable
in API is set to True.

As a demo I modified documentation of LogEntryCollectionHandler.
Basically we should fix our docstrings to comply with [5] and extend &
cleanup my docutils parsing logic in swagger.py. The plus side is that
our Sphinx documentation will get better too.

Please test it and give feedback.

P.

[1] https://review.openstack.org/#/c/179051/
[2] https://bugs.launchpad.net/fuel/+bug/1449030
[3]
http://172.18.163.4/swagger-ui/dist/index.html?url=http://localhost:8000/api/v1/docs#!/default/get_logs
[4] https://github.com/swagger-api/swagger-ui
[5] http://pythonhosted.org/sphinxcontrib-httpdomain/


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


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [ha-guide] RST guide skeleton in place

FYI, the HA spec has been approved and also the RST skeletion is now in
place: http://git.openstack.org/cgit/openstack/ha-guide/tree/doc/ha-guide

The setup of the RST guide is the same as for all other RST guides.

The guide is build as "ha-guide" as part of every change, you can check
the generated content clicking on the "checkbuild" check.

The skeleton looks like this currently:
http://docs-draft.openstack.org/42/180642/1/check/gate-ha-guide-tox-doc-publish-checkbuild/2276078//publish-docs/draft/ha-guide/index.html

It is not published anywhere at the moment, if you have enough content
that publishing a draft would help you, this can be done like with the
RST guides in openstack-manuals.

So, time to get content added ;)

For writing, please check our conventions that include RST conventions
as well: https://wiki.openstack.org/wiki/Documentation/Markup_conventions

If you want to migrate files from DocBook to RST, see
https://wiki.openstack.org/wiki/Documentation/Migrate

Andreas
--
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, Jennifer Guild, Dilip Upmanyu,
Graham Norton, HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Thanks for all the help êveryone. We havenew content and will start
dropping it in.

On Thursday, May 7, 2015, Andreas Jaeger aj@suse.com wrote:
FYI, the HA spec has been approved and also the RST skeletion is now in
place: http://git.openstack.org/cgit/openstack/ha-guide/tree/doc/ha-guide

The setup of the RST guide is the same as for all other RST guides.

The guide is build as "ha-guide" as part of every change, you can check
the generated content clicking on the "checkbuild" check.

The skeleton looks like this currently:

http://docs-draft.openstack.org/42/180642/1/check/gate-ha-guide-tox-doc-publish-checkbuild/2276078//publish-docs/draft/ha-guide/index.html

It is not published anywhere at the moment, if you have enough content
that publishing a draft would help you, this can be done like with the RST
guides in openstack-manuals.

So, time to get content added ;)

For writing, please check our conventions that include RST conventions as
well: https://wiki.openstack.org/wiki/Documentation/Markup_conventions

If you want to migrate files from DocBook to RST, see
https://wiki.openstack.org/wiki/Documentation/Migrate

Andreas
--
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, Jennifer Guild, Dilip Upmanyu,
Graham Norton, HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Autogenerate the API Reference

Hi All,

I missed the original thread with the registration to this list, so I will try to summarize my thoughts without history.

First of all, I support the idea of generating the API Reference from the source code as that is the most up to date source of information. On the other hand it makes much easier not just to create the exact document, but keep it up to date, which is unfortunately not true for some of the projects that have their API guide in OpenStack Manuals.

As for the format and placement, I think it can be an experimental process as it is described in the corresponding blueprint. As there are still projects, which have their API documentation in the project tree it shows that it is a viable solution too to put more responsibility on the project teams as opposed to leaving all on the documentation team, which has limited resources compared to the size of OpenStack at the moment.

As I mentioned the documentation, which lives together with the code, it raised a question for me. The API versioning is not always in line with the OpenStack releases neither with the changes on the API. As not every project uses micro versioning or any kind of markup, which shows the changes, it can mean that the v2 version of an API contains less endpoints in let's Juno, than in Kilo. If we document and update the API Reference based only on API versions, then we miss to capture the difference between the functionality covered in the different OpenStack releases. In case of those projects, which maintains their documentation together with the code base this should not be an issue, as the documentation is frozen on the stable branches, when those are cut from master. What do you think about this aspect? Is there a plan to address this issue too?

Best Regards,
Ildiko


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On Thu, May 7, 2015 at 9:12 AM, Ildikó Váncsa ildiko.vancsa@ericsson.com
wrote:

Hi All,

I missed the original thread with the registration to this list, so I will
try to summarize my thoughts without history.

First of all, I support the idea of generating the API Reference from the
source code as that is the most up to date source of information. On the
other hand it makes much easier not just to create the exact document, but
keep it up to date, which is unfortunately not true for some of the
projects that have their API guide in OpenStack Manuals.

As for the format and placement, I think it can be an experimental process
as it is described in the corresponding blueprint. As there are still
projects, which have their API documentation in the project tree it shows
that it is a viable solution too to put more responsibility on the project
teams as opposed to leaving all on the documentation team, which has
limited resources compared to the size of OpenStack at the moment.

As I mentioned the documentation, which lives together with the code, it
raised a question for me. The API versioning is not always in line with the
OpenStack releases neither with the changes on the API. As not every
project uses micro versioning or any kind of markup, which shows the
changes, it can mean that the v2 version of an API contains less endpoints
in let’s Juno, than in Kilo. If we document and update the API Reference
based only on API versions, then we miss to capture the difference between
the functionality covered in the different OpenStack releases. In case of
those projects, which maintains their documentation together with the code
base this should not be an issue, as the documentation is frozen on the
stable branches, when those are cut from master. What do you think about
this aspect? Is there a plan to address this issue too?

Great point Ildiko. I need to be clear in the spec that the intent is to
have a "Kilo" Dev Guide, a "Juno" Dev Guide, probably just maintaining 2
releases at a time (rather than the 3 that are security-supported). I think
it'll have to lag a release behind, so that Dev Guides are only available
for already-released services.

To keep the scope sane, I likely will start with Images v2.x API only. I'm
reaching out to that team to see if that's feasible.

So it's not about the projects microversioning each resource call
necessarily but about documenting "what can I do with a Juno-based cloud as
an app dev" -- and document ways to self-discover that also. In your case,
how would I know what calls are available in Juno, use stable branches? I
guess I point the autodoc tool at the stable branch. Hm, this might mean
some backported strings.

Each resource should have some indicator in the docs whether it's available
on Juno or Kilo, also. That's what's tougher for some APIs than others,
right?

I really want to get the proof-of-concept robust enough to matter, so
thanks for bringing up the versioning implications.

Anne

Best Regards,

Ildiko


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [networking] Meeting minutes 5/8/15

The Networking Guide has been published.

Today we mostly talked over the presentation we're giving in Vancouver
to detail this project. We have a shared doc that we will edit through
the week to get it ready.

We will try to meet at the regular time next Friday but may make due
with email since many of us will be traveling.

Next definite meeting 5/29 at 1500 utc.

----- Nick


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] training guide lab

hi All

I am testing the training guide lab.

anyone have a case or docs or anything, so i can install the step not
using osbash -b cluster, but node by node

Based on installation guide, i think that will be awesome if we can
install start from keystone, glance, nova .. from the foundation to
the end.

Help is appreciate

F


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Frans,

The point of Training Guide’s labs is easy installation of a working three node (controller, compute, network node) OpenStack cloud for Training purposes.

We don’t cover a use case where you separately install project by project. However, osbash scripts do deliberately follow install guides, so you can look at the scripts and follow along.

Matjaz

On 10 May 2015, at 08:49, Frans Thamura frans@meruvian.org wrote:

hi All

I am testing the training guide lab.

anyone have a case or docs or anything, so i can install the step not
using osbash -b cluster, but node by node

Based on installation guide, i think that will be awesome if we can
install start from keystone, glance, nova .. from the foundation to
the end.

Help is appreciate

F


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [install-guides] opensuse;sles; rabbitmq issue

Hello,

I have another workaround for making rabbitmq work for the time being. The
issue is under progress for Kilo branch at present for opensuse. For the
time being I am downloading and installing rabbitmq from another source in
OBS.

https://build.opensuse.org/package/show/network:messaging:amqp/rabbitmq-server

I am using the rpm's from here.

For SLES12 I am currently using SLES11-sp2 package which seems to work fine
for me. Should I update the workaround in the message queue section under
install guides with some quick hacks for fixing rmq?

Regards,
Pranav


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 05/11/2015 03:43 PM, Pranav Salunke wrote:
Hello,

I have another workaround for making rabbitmq work for the time being.
The issue is under progress for Kilo branch at present for opensuse. For
the time being I am downloading and installing rabbitmq from another
source in OBS.

https://build.opensuse.org/package/show/network:messaging:amqp/rabbitmq-server

Let's get this in the proper repo.

I am using the rpm's from here.

For SLES12 I am currently using SLES11-sp2 package which seems to work
fine for me. Should I update the workaround in the message queue section
under install guides with some quick hacks for fixing rmq?

Feel free to update it...

thanks,
Andreas
--
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, Dilip Upmanyu, Graham Norton,
HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [install guide] Team meeting tomorrow

Hi everyone,

The next install guide team meeting is tomorrow, 12 May, at 13:00 UTC (8:00 AM US CDT).

Links for the hangout and to add the meeting to your Google calendar are here:
https://wiki.openstack.org/wiki/Documentation/InstallGuide#Meeting_information

On the agenda:
Status updates
Pre-summit discussion

Thanks,
Karin


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] HELP! Can't build docs locally

Hi all,

I was working on an update for the Config ref guide, half way through the local build, my system rebooted as a result of something else I was working on.

When I tried to go back to the change once my machine was up again, I start getting this error:

➜ config-reference git:(dell-eql-logic-support) git s
error: object file .git/objects/91/051c2e90e25467b75a58806b0258824be06d40 is empty
error: object file .git/objects/91/051c2e90e25467b75a58806b0258824be06d40 is empty
fatal: loose object 91051c2e90e25467b75a58806b0258824be06d40 (stored in .git/objects/91/051c2e90e25467b75a58806b0258824be06d40) is corrupt

I could not use any git commands, change to master or delete this branch. On searching online, I found that the best way to tackle this would be to clone the repo again. I removed my existing repo and re-cloned it, set gerrit as remote and updated the ssh key.

Then I created a new branch and updated the changes, but when I try to build locally for review, I get the following error:

[ERROR] Failed to execute goal com.rackspace.cloud.api:clouddocs-maven-plugin:2.1.4:generate-webhelp (generate-webhelp) on project openstack-config-reference: A type incompatibility occured while executing com.rackspace.cloud.api:clouddocs-maven-plugin:2.1.4:generate-webhelp: cannot assign instance of org.apache.fop.fonts.FontTriplet to field org.apache.fop.fonts.FontTriplet.style of type java.lang.String in instance of org.apache.fop.fonts.FontTriplet

I've attached file for complete error log. I've tried the following solutions suggested by various team members - remove and re-install the maven package, delete the cache and run the 'maven' command again, but none of these options have helped.

Can you please let me know if you have any ideas on how to resolve this issue?

Thanks in advance,
Deepti

--
Deepti Navale
Content Author, Red Hat OpenStack
Customer Content Services
Red Hat Asia Pacific
Sydney, Australia
dnavale@redhat.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Hi Deepti,
We've seen this on Jenkins build jobs before. See
https://bugs.launchpad.net/openstack-manuals/+bug/1221721

I think the answer is to delete ~/.fop (based on
https://review.openstack.org/#/c/47509/4/tools/validate.py) and re-run the
mvn clean generate-sources again.

Let us know if that works.

Thanks,
Anne

On Mon, May 11, 2015 at 9:30 PM, Deepti Navale dnavale@redhat.com wrote:

Hi all,

I was working on an update for the Config ref guide, half way through the
local build, my system rebooted as a result of something else I was working
on.

When I tried to go back to the change once my machine was up again, I
start getting this error:

➜ config-reference git:(dell-eql-logic-support) git s
error: object file .git/objects/91/051c2e90e25467b75a58806b0258824be06d40
is empty
error: object file .git/objects/91/051c2e90e25467b75a58806b0258824be06d40
is empty
fatal: loose object 91051c2e90e25467b75a58806b0258824be06d40 (stored in
.git/objects/91/051c2e90e25467b75a58806b0258824be06d40) is corrupt

I could not use any git commands, change to master or delete this branch.
On searching online, I found that the best way to tackle this would be to
clone the repo again. I removed my existing repo and re-cloned it, set
gerrit as remote and updated the ssh key.

Then I created a new branch and updated the changes, but when I try to
build locally for review, I get the following error:

[ERROR] Failed to execute goal
com.rackspace.cloud.api:clouddocs-maven-plugin:2.1.4:generate-webhelp
(generate-webhelp) on project openstack-config-reference: A type
incompatibility occured while executing
com.rackspace.cloud.api:clouddocs-maven-plugin:2.1.4:generate-webhelp:
cannot assign instance of org.apache.fop.fonts.FontTriplet to field
org.apache.fop.fonts.FontTriplet.style of type java.lang.String in instance
of org.apache.fop.fonts.FontTriplet

I've attached file for complete error log. I've tried the following
solutions suggested by various team members - remove and re-install the
maven package, delete the cache and run the 'maven' command again, but none
of these options have helped.

Can you please let me know if you have any ideas on how to resolve this
issue?

Thanks in advance,
Deepti

--
Deepti Navale
Content Author, Red Hat OpenStack
Customer Content Services
Red Hat Asia Pacific
Sydney, Australia
dnavale@redhat.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Separating User Guides

Anne, Doug, and myself have been chasing some problems with the User
Guides on IRC last night (duplicate content, missing NEXT/PREVIOUS) and
we discussed separating the guides again.

There's no real benefit in having them in one directory and moving them
apart make

As part of this, I created a separate common-rst directory to share
files with.

This found a bug in in our translation setup, so we need an
openstack-doc-tools 0.28 release before we can enable translations for
the changed setup.

Find all changes via:
https://review.openstack.org/#/q/status:open+branch:master+topic:separate-user-guide,n,z

Andreas
--
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, Dilip Upmanyu, Graham Norton,
HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 05/12/2015 09:34 AM, Andreas Jaeger wrote:
Anne, Doug, and myself have been chasing some problems with the User
Guides on IRC last night (duplicate content, missing NEXT/PREVIOUS) and
we discussed separating the guides again.

There's no real benefit in having them in one directory and moving them
apart make

As part of this, I created a separate common-rst directory to share
files with.

This found a bug in in our translation setup, so we need an
openstack-doc-tools 0.28 release before we can enable translations for
the changed setup.

Find all changes via:
https://review.openstack.org/#/q/status:open+branch:master+topic:separate-user-guide,n,z

Since this is a larger patch set, any other patch for the user-guides
will cause a merge conflict. I would appreciate a quick review.

If you disagree with the approach, please speak up,

Andreas
--
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, Dilip Upmanyu, Graham Norton,
HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [install guide] Team meeting notes 12 May 2015

Small, quick meeting today.

Attendees: Matt Kassawara, Karin Levenstein, Andreas Jaeger (updates via IRC)

Ubuntu: Matt plans to re-test the guide as soon as the latest packages drop, which should include libvirt and qemu fixes
RHEL: Berendt's keystone/apache setup is currently in flight
SLES and openSUSE 13.2: installation until Horizon for these platforms works fine, another minor patch coming
In general: be prepared to re-test the guides as packages become available, triage/patch bugs as they come in.

ACTION: Karin to create WIP Liberty install guide spec so that we have something to talk about at the summit.

--
Karin K. Levenstein
Team Lead, Rackspace Private Cloud Documentation, US
karin.levenstein@rackspace.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [ha-guide] F2F meeting in Vancouver

Hi everyone,

The HA Guide team will be holding a face to face meeting in Vancouver on
Thursday (5/21) from 10:45AM to 12:30PM PT in Meeting Room #16. I look
forward to seeing those of you who can make it. Meg, I will try to setup
remote access but I won't know the feasibility of this until we are in
Vancouver.

--
Thanks,
Shamail Tahir
Cloud Architect, EMC
t: @ShamailXD
tz: Eastern Time


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [User Guides] Team Meeting for 08/05/15

Hello All,

Attendees: Lana Brindley, Alex Settle, Darren Chan, Brian Moss, Deepti Navale, Joseph Robinson

Just a few announcements before tomorrow's meeting.

The meeting time is now set for Wednesdays at 1030 UTC (Thursday 8:30am AEST)

The Blueprints work tasks have started receiving updated: https://blueprints.launchpad.net/openstack-manuals/+spec/reorganise-user-guides

The new task tracking page for improving the user guides also now active:
https://wiki.openstack.org/wiki/Documentation/ReorganizeUserGuides.

Best Regards,

Joseph Robinson
Information Developer I


+61 2 9276 3896
+61 424 970 728


Rackspace Hosting Australia PTY LTD a company registered in the state of Victoria, Australia (company registered number ACN 153 275 524) whose registered office is at Level 1, 37 Pitt Street, Sydney, NSW 2000, Australia. Rackspace Hosting Australia PTY LTD privacy policy can be viewed at www.rackspace.com.au/company/legal-privacy-statement.php - This e-mail message may contain confidential or privileged information intended for the recipient. Any dissemination, distribution or copying of the enclosed material is prohibited. If you receive this transmission in error, please notify us immediately by e-mail at abuse@rackspace.com and delete the original message. Your cooperation is appreciated.

OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 05/13/2015 09:28 AM, Joseph Robinson wrote:
Hello All,

Attendees: Lana Brindley, Alex Settle, Darren Chan, Brian Moss, Deepti
Navale, Joseph Robinson

Just a few announcements before tomorrow’s meeting.

The meeting time is now set for Wednesdays at 1030 UTC (Thursday 8:30am
AEST)

The Blueprints work tasks have started receiving updated:
https://blueprints.launchpad.net/openstack-manuals/+spec/reorganise-user-guides

The new task tracking page for improving the user guides also now active:
https://wiki.openstack.org/wiki/Documentation/ReorganizeUserGuides.

Looking at the page I see:

Remove duplication in table of contents
Several items repeat in the table of contents. Repairs to the RST
files are needed.

this is done, there shouldn't be any duplicates anymore,

Andreas
--
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, Dilip Upmanyu, Graham Norton,
HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] cannot access in openstack-dashboard

Hi all I setup openstack kilo on opensuse 13.2 properly. But i cannot
access in dashboard . when i type controller ip in browser than i see

Server error!

The server encountered an internal error and was unable to complete your
request. Either the server is overloaded or there was an error in a CGI
script.

If you think this is a server error, please contact the webmaster.
Error 500
192.168.0.10
Apache
please help me for solve this problem.

Thanks


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

A minimum of troubleshooting:
- does the IP address 192.168.0.10 look correct?
- have you double-checked your setup?
- what do you find in the Apache log files?

Am May 13, 2015 um 19:46 schrieb Md. Mohib Billah mohib@qmail.com.bd:

Hi all I setup openstack kilo on opensuse 13.2 properly. But i cannot
access in dashboard . when i type controller ip in browser than i see

Server error!

The server encountered an internal error and was unable to complete your
request. Either the server is overloaded or there was an error in a CGI
script.

If you think this is a server error, please contact the webmaster.
Error 500
192.168.0.10
Apache
please help me for solve this problem.

Thanks


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Next openstack-doc-tools release

To fix translation of RST files, we need a new release of
openstack-doc-tools with the following patch in it:

https://review.openstack.org/#/c/182178

If we don't use the tags (https://review.openstack.org/182444) we can
clean it up a bit further, but the current state does not harm.

So, unless 182444 merges soon, I'd like to see a release of
openstack-doc-tools soon. Lana, do you want to do it or shall I?

Andreas
--
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, Dilip Upmanyu, Graham Norton,
HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 05/13/2015 07:09 PM, Andreas Jaeger wrote:
To fix translation of RST files, we need a new release of
openstack-doc-tools with the following patch in it:

https://review.openstack.org/#/c/182178

If we don't use the tags (https://review.openstack.org/182444) we can
clean it up a bit further, but the current state does not harm.

So, unless 182444 merges soon, I'd like to see a release of
openstack-doc-tools soon. Lana, do you want to do it or shall I?

After IRC discussion:

0.28.0 is released now with the first patch in - now we can enable
translation again for the user guides,

Andreas
--
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, Dilip Upmanyu, Graham Norton,
HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Re: [OpenStack-docs] Anchor tag conventions

On 05/14/2015 08:21 AM, Meg McRoberts wrote:

Are you saying to not use the :ref: construction?

I was suggesting to use the :doc: construct for file links. We haven't
added that yet to the markup conventions page but I prefer that for
these kind of links.

Also, I would only add anchors if they are needed, so don't add them by
default everywhere...

Btw. I like having some convention on these, so please rework it and
then let's get it into the wiki,

Andreas
--
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, Dilip Upmanyu, Graham Norton,
HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 05/15/2015 01:05 AM, Meg McRoberts wrote:
So it's okay to use hyphens rather than underscores in file names? The
last line of "Source File Names" in
https://wiki.openstack.org/wiki/Documentation/Structure
says "Continue to use underbar as the space delimiter." May I modify
the spec? And then I will rename the
ha-guide files before they get merged.

Please write down again what you propose and then let's change the file...

I guess it is just me who thought that each file should have a
label/anchor for the top-level heading. Andreas said that
we can use "doc" to reference these docs instead. My problem is that I
have never been able to figure out what
to use as the file name for :doc: -- the Sphinx documentation doesn't
make sense to me.

The openstack-manuals RST files like the user-guide use :doc: already,
have a look a the repo.

Is there a reason we are using the term "anchor" instead of the term
"label" that the Sphinx/RST docs use?

And do we need conventions for the content of labels/anchors? The
ha-guide is in its own repo so I don't anticipate
any problems but it might be good to have some sort of convention since
a label/anchor must be unique for the entire
set -- I can see the potential for conflicts on terms like install,
troubleshoot, et cetera...

Our conventions apply to all repos to make reviewing and appearance
consistent.

Labels are unique within a single manual, so that should be fine in general.

I don't know whether we need a convention on format of it. Feel free to
propose something,

Andreas

meg

------------------------------------------------------------------------
*From:* Anne Gentle <annegentle@justwriteclick.com>
*To:* Andreas Jaeger <aj@suse.com>
*Cc:* Meg McRoberts <dreidellhasa@yahoo.com>;
"openstack-docs@lists.openstack.org"
<openstack-docs@lists.openstack.org>
*Sent:* Thursday, May 14, 2015 5:58 AM
*Subject:* Re: [OpenStack-docs] Anchor tag conventions



On Thu, May 14, 2015 at 12:30 AM, Andreas Jaeger <aj@suse.com
<mailto:aj@suse.com>> wrote:

    On 05/13/2015 11:50 PM, Meg McRoberts wrote:

        Hi all,
        I am creating files for the ha-guide content and have a
        question about
        what the OpenStack docs call
        "embedded anchor pointers" and the Sphinx docs call labels.
        Basically,
        this is the string that you use
        in a :ref: construct to link to a section.  It is coded just
        above the
        section title.  For example:

        .. _anchor-for-ha-intro:

        ============================================
        Introduction to Highly Available OpenStack environments
        ============================================

        It makes sense to use the file name (minus the .rst
        extension) for the
        labels, except that the Structure
        standard specifies using underbar as the space delimiter,
        and underbars
        in these labels can confuse
        Sphinx.

        I would suggest one of the following:

        - Use hyphen rather than underscore for RST source file
        names, then use
        that name as the top-level label
            for that section, so the filename would be intro-ha.rst
        rather than
        intro_ha.rst  (preferred)
        - Replace the underbars in file names with hyphens for labels.

        What does everyone else think?


For file names, yes hyphens.

Unless you are linking to a heading lower down in the file, I don't
believe the label is required. I wonder why those are being added?


    You can reference files by name, can't you?


The anchor convention is for linking within a longer file. But maybe
the labels offer something? I'd rather always reference whole files
by name.


    Andreas
    --
      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, Dilip Upmanyu, Graham
    Norton,
            HRB 21284 (AG Nürnberg)
         GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C
    C272 A126



    _______________________________________________
    OpenStack-docs mailing list
    OpenStack-docs@lists.openstack.org
    <mailto:OpenStack-docs@lists.openstack.org>
    http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs




--
Anne Gentle
annegentle@justwriteclick.com <mailto:annegentle@justwriteclick.com>

--
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, Dilip Upmanyu, Graham Norton,
HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [training-guides] New training guides design meeting time

Thursday, dev lounge at 13:30?

~ sean


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Works for me, we could have lunch together and then have the design session.

Regards.
Pranav

On Sun, May 17, 2015 at 7:25 PM, sean roberts seanroberts66@gmail.com
wrote:

Thursday, dev lounge at 13:30?

~ sean


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Translators working session in Vancouver

Hello, doc team

There is a translators working session in Vancouver on May 18th 12:05pm,
room 224.
There are some discussions related with documentation.

If you are available at that time, come and join the talk with translators.
The agenda is https://etherpad.openstack.org/p/Vancouver-I18n-WG-session
The session is
https://openstacksummitmay2015vancouver.sched.org/event/f008932bfc685abe74276a20f41777c6#.VVWfJ5M5ClI

Best regards
Ying Chun Guo (Daisy)_______________________________________________
OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] DocTeam meeting U.S.

Hi All,

Just want to give a heads up that the (U.S) meeting will be canceled for
this week because of the conference going on in Vancouver. Hope to catch up
with you all at the conference or afterwards on IRC. Thank you!

Shilla


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [User Guides] User Guide meeting May 21 2015

Hello All,

Just a short message to say that the User Guide specialty team meeting this week will not be held due to the Vancouver Docs summit. Meetings will resume next week, May 28.

Best Regards,

Joseph Robinson
Information Developer I


+61 2 9276 3896
+61 424 970 728


Rackspace Hosting Australia PTY LTD a company registered in the state of Victoria, Australia (company registered number ACN 153 275 524) whose registered office is at Level 1, 37 Pitt Street, Sydney, NSW 2000, Australia. Rackspace Hosting Australia PTY LTD privacy policy can be viewed at www.rackspace.com.au/company/legal-privacy-statement.php - This e-mail message may contain confidential or privileged information intended for the recipient. Any dissemination, distribution or copying of the enclosed material is prohibited. If you receive this transmission in error, please notify us immediately by e-mail at abuse@rackspace.com and delete the original message. Your cooperation is appreciated.

OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Thanks Joseph!

L

On 19 May 2015, at 7:14 pm, Joseph Robinson joseph.robinson@RACKSPACE.COM wrote:

Hello All,

Just a short message to say that the User Guide specialty team meeting this week will not be held due to the Vancouver Docs summit. Meetings will resume next week, May 28.

Best Regards,

Joseph Robinson
Information Developer I


+61 2 9276 3896
+61 424 970 728

Rackspace Hosting Australia PTY LTD a company registered in the state of Victoria, Australia (company registered number ACN 153 275 524) whose registered office is at Level 1, 37 Pitt Street, Sydney, NSW 2000, Australia. Rackspace Hosting Australia PTY LTD privacy policy can be viewed at www.rackspace.com.au/company/legal-privacy-statement.php - This e-mail message may contain confidential or privileged information intended for the recipient. Any dissemination, distribution or copying of the enclosed material is prohibited. If you receive this transmission in error, please notify us immediately by e-mail at abuse@rackspace.com and delete the original message. Your cooperation is appreciated.


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Errors running git rebase -p -i remotes/gerrit/master

Hi. Is there anybody not in Vancouver?

My patch [1] is still not production-ready, but I would like to upload an
intermediate result to Gerrit. Since others are working with
openstack-manuals, I am getting this error:

$ git review
Errors running git rebase -p -i remotes/gerrit/master
fatal: Commit 094a04b15ce073223ee34717e8c991a2e54ff60b is a merge

but no -m option was given.
Could not pick 094a04b15ce073223ee34717e8c991a2e54ff60b

I could try "git review -m", but I am afraid of possible undesirable
consequences that I don't understand due to my mediocre knowledge of git.

Any advice?

Bernd

[1] https://review.openstack.org/#/c/180503/ if you are really interested.


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Hi Bernd,

I'm in Vancouver but I'll try to help anyway ;)

Le 2015-05-20 04:29, Bernd Bausch a écrit :

Hi. Is there anybody not in Vancouver?

My patch [1] is still not production-ready, but I would like to upload
an
intermediate result to Gerrit. Since others are working with
openstack-manuals, I am getting this error:

$ git review
Errors running git rebase -p -i remotes/gerrit/master
fatal: Commit 094a04b15ce073223ee34717e8c991a2e54ff60b is a merge
but no -m option was given.
Could not pick 094a04b15ce073223ee34717e8c991a2e54ff60b

I could try "git review -m", but I am afraid of possible undesirable
consequences that I don't understand due to my mediocre knowledge of
git.

I usually use 'git review -d REVIEW_ID' to get gerrit reviews. 'git
review' should handle the update of a local branch if needed.

Let me know if this works for you.

Gauvain

Any advice?

Bernd

[1] https://review.openstack.org/#/c/180503/ if you are really
interested.


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Gauvain Pocentek

Objectif Libre - Infrastructure et Formations Linux
http://www.objectif-libre.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] design of http://developer.openstack.org/ broken?

Is the design of http://developer.openstack.org/ only broken on my
Laptop? Or is it broken at all? I does not look correct here.

Christian.


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

yeah, looks a bit odd. My guess is a missing close tag for one of the
elements.

On 20/05/15 09:54, Christian Berendt wrote:
Is the design of http://developer.openstack.org/ only broken on my
Laptop? Or is it broken at all? I does not look correct here.

Christian.


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Working Sessions at Summit Question

Hi,

I didn't see a specific contact on any of the websites or docs, so I'm
putting the question out here. I'm at the Vancouver Summit and would like
to attend the documentation design sessions. I'm gearing up to be a
contributor but haven't made my first commit yet. Is it okay to attend?

Thanks,
Amanda


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Absolutely! We'd love to see you. Just find us on the schedule and say hi when reach the room.

----Original Message-----
From: "APlimpton" aplimpton@gmail.com
Sent: Thu, 21 May, 2015 at 07:03
To: openstack-docs@lists.openstack.org
Cc: openstack-docs@lists.openstack.org
Subject: [OpenStack-docs] Working Sessions at Summit Question

Hi,

I didn't see a specific contact on any of the websites or docs, so I'm
putting the question out here. I'm at the Vancouver Summit and would like
to attend the documentation design sessions. I'm gearing up to be a
contributor but haven't made my first commit yet. Is it okay to attend?

Thanks,
Amanda


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] PDF files for our RST guides available?

Yestereday I got the feedback that we do not provide PDF files for our
RST guides. Why not? Have we forgot it?

For example we provide PDF files for our installation guide
(http://docs.openstack.org/kilo/install-guide/install/zypper/openstack-install-guide-zypper-draft.pdf).

But we do not have a PDF files for example for the networking guide.

Christian.


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Not forgotten, only prioritized. :) Here's the bug for tracking purposes,
feel free to pick it up:

https://bugs.launchpad.net/openstack-manuals/+bug/1427246

On Thu, May 21, 2015 at 12:32 PM, Christian Berendt christian@berendt.io
wrote:

Yestereday I got the feedback that we do not provide PDF files for our RST
guides. Why not? Have we forgot it?

For example we provide PDF files for our installation guide (
http://docs.openstack.org/kilo/install-guide/install/zypper/openstack-install-guide-zypper-draft.pdf
).

But we do not have a PDF files for example for the networking guide.

Christian.


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Specialty teams connecting to translation team

Hi all,
I'm sitting here in Vancouver next to Daisy (Ying Chun Guo) who leads the
i18N efforts for OpenStack. She would like each specialty team lead to
connect with the i18N team to communicate the amount of change expected so
that they can evaluate the timing of translation, and how much is done that
can be translated.

We also had a session with the i18N team and want to work on more
communication with each team, and I think the specialty team leads are a
great way to start that effort.

Thoughts or ideas? Let us know.
Thanks,
Anne

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Thank you, Anne.

We use a wiki page to track the status of documentation:
https://wiki.openstack.org/wiki/I18nTeam/docs-translation#Document_categorize

I hope specialty team leads could keep an eye on this table.
If there is any changes of your documents, like, changing from stable to
unstable, changing from unstable to stable,
let the translation team know by sending an email to openstack-i18n mailing
list.
So that we could make a translation plan for your documents.

Thanks.
Best regards
Ying Chun Guo (Daisy)

Anne Gentle annegentle@justwriteclick.com wrote on 2015/05/22 01:35:14:

From: Anne Gentle annegentle@justwriteclick.com
To: "openstack-docs@lists.openstack.org" , "openstack-i18n@lists.openstack.org"
openstack-i18n@lists.openstack.org
Date: 2015/05/22 01:35
Subject: [Openstack-i18n] Specialty teams connecting to translation team

Hi all,
I'm sitting here in Vancouver next to Daisy (Ying Chun Guo) who
leads the i18N efforts for OpenStack. She would like each specialty
team lead to connect with the i18N team to communicate the amount of
change expected so that they can evaluate the timing of translation,
and how much is done that can be translated.

We also had a session with the i18N team and want to work on more
communication with each team, and I think the specialty team leads
are a great way to start that effort.

Thoughts or ideas? Let us know.
Thanks,
Anne

--
Anne Gentle

annegentle@justwriteclick.com_______________________________________________

Openstack-i18n mailing list
Openstack-i18n@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-i18n_______________________________________________
OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] config-ref specialty team

Hi all,

The doc session we had with the operators yesterday convinced me that
we need to give more love to the configuration reference. Putting up a
specialty team for it seems like a good idea. I'd like to know if there
are people interested in working on this.

I really think that the cloud admin guide could/should be handled by
this team too, but the user guide team will work on it to handle the RST
migration. I'm not sure what should happen on this front TBH, so let me
know what you think.

Thanks,
Gauvain


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 05/21/2015 08:25 PM, Gauvain Pocentek wrote:
Putting up a
specialty team for it seems like a good idea. I'd like to know if there
are people interested in working on this.

Interested.

Christian.

--
Christian Berendt
Cloud Solution Architect
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Install for Oxygen

Dell - Internal Use - Confidential

The default.xpr link on the page https://wiki.openstack.org/wiki/Documentation/HowTo#Edit_OpenStack_RST_and.2For_DocBook_documentation does not go to a recognized file. Does someone have the correct one?

Oxygen and the Rackbook Framework

Due to Rackspace maintaining Oxygen tools that make authoring DocBook and WADL easier, we can offer a Rackbook framework. You can run directly from http://docs.rackspace.com/oxygen/. You will need to add a valid Oxygen license to use the application.

Alternatively, download the oxygen-frameworks.ziphttp://feline.thingbag.net/oxygen-frameworks.zip file. Next, download the following file to your system: defaults.xprhttp://wiki.openstack.org/Documentation/HowTo?action=AttachFile&do=get&target=defaults.xpr. Extract the oxygen-frameworks.zip file to ~/Library/Preferences (i.e. so you end up with /Users/your.username/Library/Preferences/com.oxygenxml.author). In Oxygen, go to Options->Import Global Options. Navigate to the downloaded defaults.xpr file and click Open.You should see a new bar of buttons and a Rackbook menu item.

--Randy


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Hi Randy,
Sorry about that! That particular file is for Oxygen, but doesn't seem to
be downloadable from the wiki. The original idea is that we all use similar
defaults so that comparison diffs in gerrit are (slightly) easier to read.
I've deleted the wiki section you found that in, and instead described the
common options file in
https://wiki.openstack.org/wiki/Documentation/HowTo#Editor_Options

"To get some standard settings, visit http://docs.rackspace.com/oxygen/ and
download the Global Options File and import it into Oxygen."

Thanks,
Anne

On Thu, May 21, 2015 at 3:56 PM, Randy_Perryman@dell.com wrote:

*Dell - Internal Use - Confidential *

The default.xpr link on the page
https://wiki.openstack.org/wiki/Documentation/HowTo#Edit_OpenStack_RST_and.2For_DocBook_documentation
does not go to a recognized file. Does someone have the correct one?

Oxygen and the Rackbook Framework

Due to Rackspace maintaining Oxygen tools that make authoring DocBook and
WADL easier, we can offer a Rackbook framework. You can run directly from
http://docs.rackspace.com/oxygen/. You will need to add a valid Oxygen
license to use the application.

Alternatively, download the oxygen-frameworks.zip
file. Next, download
the following file to your system: defaults.xpr
.
Extract the oxygen-frameworks.zip file to ~/Library/Preferences (i.e. so
you end up with
/Users/your.username/Library/Preferences/com.oxygenxml.author). In Oxygen,
go to Options->Import Global Options. Navigate to the downloaded
defaults.xpr file and click Open.You should see a new bar of buttons and a
Rackbook menu item.

--Randy


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] NooB Windows 7 question

Dell - Internal Use - Confidential
I am trying to setup my Windows 7 system to build the documents RST documents. I am hitting an error:

InterpreterNotFound: python2.7

When I type : tox –e py27 in the openstack-manuals directory.

I have python 2.7.9 installed

Any suggestions?

-Randy


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Hi Randy,
So, I have Windows 8.1 Pro at home and followed all these steps to set up
git and git bash:

http://guides.beanstalkapp.com/version-control/git-on-windows.html

I open an Explorer window, browse to the openstack-manuals folder, and use
the "Git Bash Here" when I need a PowerShell prompt. (Screenshots attached.)

I can run tox -e py27. Running some of the check tests isn't working,
checkniceness works but checksyntax does not, due to an Invocation Error
that I am not sure how to debug. I think it can't use the find command or
some such.

It stalled for a lonnnng time on the tox -e docs command, and then says "%1
is not a valid Win32 application," so I'm not sure if that's just the story
on my circa-2013 computer or what. It's running the
tools/build-user-guides.sh file and that's not written for Windows.

Does that give you more ideas for testing more? Let me know if you get
unstuck. We have tried and tried to get Windows machines onboarded with
little success but it would be nice to get a working environment
documented. It's a lot of effort to get cross-platform tested and working
so feel free to post suggestions.
Anne

On Thu, May 21, 2015 at 6:01 PM, Randy_Perryman@dell.com wrote:

*Dell - Internal Use - Confidential *

I am trying to setup my Windows 7 system to build the documents RST
documents. I am hitting an error:

InterpreterNotFound: python2.7

When I type : tox –e py27 in the openstack-manuals directory.

I have python 2.7.9 installed

Any suggestions?

-Randy


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Renaming Virtual Machine Image Guide

Hi team,

Adrien has approached me at Summit to discuss renaming the Virtual Machine Image Guide to something more appropriate, probably something like the Cloud Image Guide. He originally proposed this in https://bugs.launchpad.net/openstack-manuals/+bug/1438597 and I said I wanted to have more discussion about it before we made a decision.

Can you please reply to this email and let me know if you approve of changing the name of the guide and, if so, what you think it should be called? The main argument I can see is that the word ‘cloud’ is a broader definition than the word ‘virtual machine’ and we need to be a little more generic.

Looking forward to hearing your thoughts.

Lana

Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

I understand and to a degree agree with your comment on the bug page, Lana, but I think there's a case to be made for clarity and simplicity in what we choose for titles. I do think it would be appropriate to change this one, for the reasons Adrien has suggested as a start, and would offer "OpenStack Image Guide" as one alternative.

It's worth noting - to Adrien's comment about bare metal instances - that the introduction focuses extensively on the concept of virtual machine images. We should consider that if we rename the guide it might open the door to further modifications, not necessarily, but....

/Harry

On 05/22/2015 02:51 PM, Lana Brindley wrote:
Hi team,

Adrien has approached me at Summit to discuss renaming the Virtual Machine Image Guide to something more appropriate, probably something like the Cloud Image Guide. He originally proposed this in https://bugs.launchpad.net/openstack-manuals/+bug/1438597 and I said I wanted to have more discussion about it before we made a decision.

Can you please reply to this email and let me know if you approve of changing the name of the guide and, if so, what you think it should be called? The main argument I can see is that the word ‘cloud’ is a broader definition than the word ‘virtual machine’ and we need to be a little more generic.

Looking forward to hearing your thoughts.

Lana

Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [install-guide] No team meeting this week

The next install guide team meeting will be Tuesday 2 June, at the usual time.

In the meantime, please send me any status updates, and please review the WIP blueprint and spec for Liberty:

https://blueprints.launchpad.net/openstack-manuals/+spec/installguide-liberty
https://review.openstack.org/#/c/183138/

Sent using OWA for iPad


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Admin Guide versioning

Hi Lana,

As we discussed on the summit I reported a bug for the issue mentioned in the subject: https://bugs.launchpad.net/openstack-manuals/+bug/1458820

I think it would be better to maintain stable versions for this guide too like what we have for the Config Reference or the Install Guide. What is your opinion?

Thanks,
Ildikó


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 26/05/15 20:44, Ildikó Váncsa wrote:
Hi Lana,

As we discussed on the summit I reported a bug for the issue mentioned in the subject: https://bugs.launchpad.net/openstack-manuals/+bug/1458820

I think it would be better to maintain stable versions for this guide too like what we have for the Config Reference or the Install Guide. What is your opinion?

Hi Ildikó,

Would it better if we just moved the Ceilometer content into the Config
Reference instead?

L


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVZOlUAAoJELppzVb4+KUyGgMH/1HT+AjQ0dySX37nM3gvJ0yF
lSb+IHDAAacHTHd4fPiD2jBov9gbgSBe7XTcUt9SH6CXMOMpuJoig6MneWSjrdwk
WQzSYjAHFK5X5/huF4YCuQEKy2aP/ncPJgFmc1ckuN2VhCtTI6u4W4i0kmo/kZy7
PItr6snXJsTIPn2YsdeDjBd6IsZunY/mdXCYgyUjuuUwhIhcqi/Dq8He0yee39rw
aSsiHNydL4FYt5AppyDAVRByjpyygeRAV9ViIo7y7z1H7YwkGSe5UGDETgC/t8Va
hbj+YsIqDQLOy5rj2CD4RlR+Pjah8m6WYW5uFNlIPqtvUDjqL1ocgrr9q/ITi9o=
=z8cV
-----END PGP SIGNATURE-----


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Trying to run tox -e py27

Found that the command

tox -e py27 is failing on the item:

tox install sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3

-bash: 1.3: no such file or directory

As I am not familiar with pip syntax not sure if the ,<1.3 is valid

-Randy


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Bash shouldn't be interpreting those arguments.

On Tue, May 26, 2015 at 8:54 AM, Randy_Perryman@dell.com wrote:

Found that the command

tox –e py27 is failing on the item:

tox install sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3

-bash: 1.3: no such file or directory

As I am not familiar with pip syntax not sure if the ,<1.3 is valid

*-Randy *


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Doc team meeting this week

Hi all,

The calendar shows tomorrow morning is the next upstream team meeting.

Shilla, are you all set? Lana, does that match your calendar expectations?

Seems like we got off-sync from the ical published via Google so wanted to
double-check. I'm traveling the rest of this week but should be able to
attend if it's tomorrow morning.

Thanks,
Anne

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Hello!

Yes, I am all set for tomorrows meeting and looking forward to it.

Shilla

On Tue, May 26, 2015 at 1:39 PM, Anne Gentle annegentle@justwriteclick.com
wrote:

Hi all,

The calendar shows tomorrow morning is the next upstream team meeting.

Shilla, are you all set? Lana, does that match your calendar expectations?

Seems like we got off-sync from the ical published via Google so wanted to
double-check. I'm traveling the rest of this week but should be able to
attend if it's tomorrow morning.

Thanks,
Anne

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] What is the OS that most people use?

Dell - Internal Use - Confidential
What is the OS that most people use?


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On Tue, May 26, 2015 at 12:41 PM, Randy_Perryman@dell.com wrote:

*Dell - Internal Use - Confidential *

What is the OS that most people use?

I've never polled to find out. I'm guessing Mac OS X.


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Reminder: APAC docs meeting

Hi everyone,

Just a gentle reminder that the APAC docs meeting will be kicking off in about thirty minutes, at 0030 UTC. The updated agenda is now available at: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting Feel free to add in anything I’ve missed :)

L

Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Yes actually I have the US meeting in my calendar to come up on the 3rd of
June.

On Tue, May 26, 2015 at 7:56 PM, Lana Brindley openstack@lanabrindley.com
wrote:

Hi everyone,

Just a gentle reminder that the APAC docs meeting will be kicking off in
about thirty minutes, at 0030 UTC. The updated agenda is now available at:
https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting Feel
free to add in anything I’ve missed :)

L

Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] How to tackle DocImpact bugs (specifically: Glance metadata catalog)

Launchpad has two DocImpact bugs about the glance metadata catalog (see
links after this paragraph). While the developer docs now contain
information about the metadata catalog, there is nothing in the
user/administrator docs. I suppose this is why they are still open.
https://bugs.launchpad.net/openstack-manuals/+bug/1366286 "Glance Metadata
Definitions Catalog - Seed"
https://bugs.launchpad.net/openstack-manuals/+bug/1378237 "Glance metadata
concepts need to be added"

Before I jump in and work on this, I have a few questions that this
community may be able to help with.

  • Which book(s) would this normally go to? For example, a page in the Glance
    CLI docs that covers the commands, a page in the admin guide that covers the
    concepts and workflow - would you agree?

  • while the developer docs cover the concepts and the API, I would really
    like to know what led to the addition of the metadata catalog (what itch
    does it scratch, so to speak), and what good and bad use cases can be
    proposed. My immediate reflex would be asking the developer community or
    start with the Glance docs liaison. Other suggestions?
    (if a glance developer reads this, feel free to jump in :)

  • Finally, should I be fazed by the fact that there are (at least) two
    DocImpact bugs? I would think one stone kills both birds in this case. Can I
    put a double "closes-bug" clause in my git header?

Bernd


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] git-review links

Hi,

On the HowTo wiki page I found a dead link for more info/tutorial on
git-review. This lead to checking the github page which gave a dead link to
a page on docs.openstack.org.

Links:
https://wiki.openstack.org/wiki/Documentation/HowTo
1.4.2 Downloadthedocumentation
3. Enter your Launchpad account…
* http://blog.invisible.ch/2013/05/06/7-getting-git-review-to-work/

https://github.com/openstack-infra/git-review
* http://docs.openstack.org/developer/git-review

http://git.openstack.org/cgit/openstack-infra/git-review/tree/README.rst
* http://docs.openstack.org/developer/git-review

Question 1: Anyone know what would be a good alternative for the
http://blog.invisible.ch/2013/05/06/7-getting-git-review-to-work/ link?

Question 2: Is there a updated link for the
http://docs.openstack.org/developer/git-review page? I tried to look for it
on the site but did not locate it.

Thanks,
Amanda


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 05/27/2015 08:29 AM, APlimpton wrote:
Question 2: Is there a updated link for the
http://docs.openstack.org/developer/git-review page? I tried to look for
it on the site but did not locate it.

This URL is broken in the README file of git-review itself
(https://github.com/openstack-infra/git-review). Actually I cannot find
the documentation of git-review.

Christian.

--
Christian Berendt
Cloud Solution Architect
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] deprecation/future of "OpenStack Operations Guide"

I want to discuss the deprecation/future of the "OpenStack Operations
Guide" (I forgot to do this in Vancouver).

At the moment we list the "OpenStack Operations Guide" on docs.o.o in
the "Operations And Administration Guides" listing.

In my understanding docs.o.o lists documentation that is maintained by
us and is usable with the current stable release.

I think we should introduce a new listing "Booksprints" on docs.o.o to
clarify that the Operations Guide is the result of a booksprint provided
"as-is".

What do you think about this?

Christian.


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On Wed, May 27, 2015 at 1:49 AM, Christian Berendt christian@berendt.io
wrote:

I want to discuss the deprecation/future of the "OpenStack Operations
Guide" (I forgot to do this in Vancouver).

At the moment we list the "OpenStack Operations Guide" on docs.o.o in the
"Operations And Administration Guides" listing.

In my understanding docs.o.o lists documentation that is maintained by us
and is usable with the current stable release.

I think we should introduce a new listing "Booksprints" on docs.o.o to
clarify that the Operations Guide is the result of a booksprint provided
"as-is".

Honestly, it's not my vision for booksprint created books to be treated as
"other" and we strategically have had booksprints for books we want to
maintain moving forward. I think in this case, the book is so well-edited
that people don't work on it. Also the original authors are all way too
busy with other work to be maintainers.

So, I'd like to see it get care and feeding. What could we do to get
maintainers on it?

What do you think about this?

Christian.


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [networking] This Friday's meeting

I can't make it this Friday, and I see a couple of other people can't as
well. I think we're all recovering from the summit; anybody want to run
it in my absence, or do you want to postpone?

---- Nick


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On Wed, May 27, 2015 at 09:23:55AM EDT, Nick Chase wrote:
I can't make it this Friday, and I see a couple of other people can't as
well. I think we're all recovering from the summit; anybody want to run it
in my absence, or do you want to postpone?

Postpone is my vote - it's just not the same without you Nick! ;)
--
Sean M. Collins


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Wrapup - Liberty Design Summit

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi everyone,

I've (finally!) finished going through all the etherpads and summarising
them. You can read the full thing here:
https://wiki.openstack.org/wiki/Documentation/Liberty and the original
etherpads are still alive, linked from here:
https://wiki.openstack.org/wiki/Design_Summit/Liberty/Etherpads#Documentation

For the TL;DR version, I've summarised everything into a few key goals
for Liberty:

  • RST Conversion:

    • Install Guide
    • Cloud Admin Guide
    • HA Guide
    • CLI reference
  • Restructure user guides
  • Increased communication with documentation liaisons, other PTLs, and i18n
  • Update the way we select core team
  • Update contributor guides
  • Clean up the DocImpact bug workflow, and clean out old bugs
  • Find a way to get docs people more involved with dev groups (midcycles)
  • Increase collaboration with corporate contributors

If you think I've missed something, or you want to add commentary to any
of these goals, please feel free to contact me. I am, as always, happy
to go through things in more depth

Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVZlTdAAoJELppzVb4+KUyM+sH+wb/vqLVPIQi/2AZleEBkXC5
cBwoiAriPYFj6poc69Qz6x8/IaLi5vekSkBsNeniWImnzJjMiawkg/yyFTT7pZ3f
sH0QjyZbjiJeyuy3voUs9lznn27Ho0Hlnc4JrD+6z9Gdsm20ZoVz4ISlfWrLRTa+
o4gxYQOm9j3Lq+2ZrJrBJ5FsuCHOSpqVpTYzMQGLYkJKYl/MELNxr1OhbFcd1tFs
r5VNanUVBl3F7Z60KdJe/ZWOmOLaz6mSI9tGprlitg/7LNckPYVoA1map20pdoA2
qZuBBJIv6iDCNmBZUzhatAMHN920m+fo04Bpf8kO+pciC9X1Roy/GVMVyyARCIw=
=uoHD
-----END PGP SIGNATURE-----


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 05/28/2015 01:35 AM, Lana Brindley wrote:
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi everyone,

Thanks Lana for the writeup! I'll read later through all of it, having
this is great for me as I couldn't make it to Vancouver.

I've (finally!) finished going through all the etherpads and summarising
them. You can read the full thing here:
https://wiki.openstack.org/wiki/Documentation/Liberty and the original
etherpads are still alive, linked from here:
https://wiki.openstack.org/wiki/Design_Summit/Liberty/Etherpads#Documentation

For the TL;DR version, I've summarised everything into a few key goals
for Liberty:

  • RST Conversion:

    • Install Guide
    • Cloud Admin Guide
    • HA Guide
    • CLI reference
  • Restructure user guides
  • Increased communication with documentation liaisons, other PTLs, and i18n
  • Update the way we select core team
  • Update contributor guides

Whoever updates them, please avoid any duplication with
http://docs.openstack.org/infra/manual/developers.html and if there's
content missing, improve that one,

Andreas

  • Clean up the DocImpact bug workflow, and clean out old bugs
  • Find a way to get docs people more involved with dev groups (midcycles)
  • Increase collaboration with corporate contributors

If you think I've missed something, or you want to add commentary to any
of these goals, please feel free to contact me. I am, as always, happy
to go through things in more depth

Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVZlTdAAoJELppzVb4+KUyM+sH+wb/vqLVPIQi/2AZleEBkXC5
cBwoiAriPYFj6poc69Qz6x8/IaLi5vekSkBsNeniWImnzJjMiawkg/yyFTT7pZ3f
sH0QjyZbjiJeyuy3voUs9lznn27Ho0Hlnc4JrD+6z9Gdsm20ZoVz4ISlfWrLRTa+
o4gxYQOm9j3Lq+2ZrJrBJ5FsuCHOSpqVpTYzMQGLYkJKYl/MELNxr1OhbFcd1tFs
r5VNanUVBl3F7Z60KdJe/ZWOmOLaz6mSI9tGprlitg/7LNckPYVoA1map20pdoA2
qZuBBJIv6iDCNmBZUzhatAMHN920m+fo04Bpf8kO+pciC9X1Roy/GVMVyyARCIw=
=uoHD
-----END PGP SIGNATURE-----


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

--
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, Dilip Upmanyu, Graham Norton,
HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Fwd: Re: [Openstack] Documentation for Neutron L3 / VXLAN with LinuxBridge...

Just want to forward this. Have we already planned to document how to
use L3 / VXLAN with LinuxBridge in the Networking Guide?

Christian.

-------- Forwarded Message --------
Subject: Re: [Openstack] Documentation for Neutron L3 / VXLAN with
LinuxBridge...
Date: Fri, 17 Apr 2015 20:21:57 -0500
From: Anne Gentle annegentle@justwriteclick.com
To: Martinx - ジェームズ thiagocmartinsc@gmail.com
CC: openstack@lists.openstack.org openstack@lists.openstack.org

On Fri, Apr 17, 2015 at 8:01 PM, Martinx - ã¸ã§ã¼ã ãº
<thiagocmartinsc@gmail.com thiagocmartinsc@gmail.com> wrote:

 Hey guys,

 Â Where can I find a complete documentation to make use of
 LinuxBridges, instead of OpenvSwitch, when using it with VXLAN?

 Â I faced too many problems with OVS in the past (also these days)
 and now, even Rackspace deploys their RPC v9 and v10 with
 LinuxBridges but, where are the documents?

  I'm reading now, the following  Ansible files, to try to figure
 this out:

 Â https://github.com/stackforge/os-ansible-deployment

 Â But, this isn't a documentation... Â  :-P

:)

Try:

http://docs.rackspace.com/rpc/api/v10/bk-rpc-installation/content/sec-hosts-target-network-example.html
Â

 Â The current Juno documents only explain GRE + OVS but, this setup
 is unstable and slow.

 Cheers!
 Thiago

 _______________________________________________
 Mailing list:
 http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack
 Post to     : openstack@lists.openstack.org
 <mailto:openstack@lists.openstack.org>
 Unsubscribe :
 http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack

--
Anne Gentle
annegentle@justwriteclick.com annegentle@justwriteclick.com

--
Christian Berendt
Cloud Solution Architect
Tel.: +49-171-5542175
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

We did...

http://docs.openstack.org/networking-guide/deploy_scenario1b.html

On Thu, May 28, 2015 at 1:19 AM, Christian Berendt christian@berendt.io
wrote:

Just want to forward this. Have we already planned to document how to use
L3 / VXLAN with LinuxBridge in the Networking Guide?

Christian.

-------- Forwarded Message --------
Subject: Re: [Openstack] Documentation for Neutron L3 / VXLAN with
LinuxBridge...
Date: Fri, 17 Apr 2015 20:21:57 -0500
From: Anne Gentle annegentle@justwriteclick.com
To: Martinx - ジェームズ thiagocmartinsc@gmail.com
CC: openstack@lists.openstack.org openstack@lists.openstack.org

On Fri, Apr 17, 2015 at 8:01 PM, Martinx - ジェームズ
<thiagocmartinsc@gmail.com thiagocmartinsc@gmail.com> wrote:

Hey guys,

 Where can I find a complete documentation to make use of
LinuxBridges, instead of OpenvSwitch, when using it with VXLAN?

 I faced too many problems with OVS in the past (also these days)
and now, even Rackspace deploys their RPC v9 and v10 with
LinuxBridges but, where are the documents?

 I'm reading now, the following  Ansible files, to try to figure
this out:

 https://github.com/stackforge/os-ansible-deployment

 But, this isn't a documentation...   :-P

:)

Try:

http://docs.rackspace.com/rpc/api/v10/bk-rpc-installation/content/sec-hosts-target-network-example.html
Â

 The current Juno documents only explain GRE + OVS but, this setup
is unstable and slow.

Cheers!
Thiago

_______________________________________________
Mailing list:
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack
Post to     : openstack@lists.openstack.org
<mailto:openstack@lists.openstack.org>
Unsubscribe :
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack

--
Anne Gentle
annegentle@justwriteclick.com annegentle@justwriteclick.com

--
Christian Berendt
Cloud Solution Architect
Tel.: +49-171-5542175
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Kilo branch

We have not yet created the Kilo branch. Are we ready to do this?

The installation guide should be fine for the moment.

Christian.


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 05/28/2015 02:21 PM, Christian Berendt wrote:
We have not yet created the Kilo branch. Are we ready to do this?

The installation guide should be fine for the moment.

Yes - but let's schedule it.

I suggest we do it early next week, let's say Tuesday. I can work with
the infra team on this,

Andreas
--
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, Dilip Upmanyu, Graham Norton,
HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Not Clear - RE: What is the OS that most people use?

Dell - Internal Use - Confidential

This was not "What OS are you running OpenStack with?"

This question was to find what OS is being used by people to create, build and test the documentation sources with. I have been trying to install to my Windows 7 machine with no luck, moved to Fedora and hit issues. As the Getting Started in Documentation Guide does not specify an OS to work with specifically, I thought I would ask.

This way, if I could run one most people are using, then it would be easier to ask questions.

-Randy


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

I have no problems with CentOS 6.6.
I also tried Cygwin on Windows 7, but was unable to build the documentation with it. Possibly due to inexperience.

On 5/28/2015 9:58 PM, Randy_Perryman@Dell.com wrote:

This question was to find what OS is being used by people to create, build and test the documentation sources with. I have been trying to install to my Windows 7 machine with no luck, moved to Fedora and hit issues. As the Getting Started in Documentation Guide does not specify an OS to work with specifically, I thought I would ask.

This way, if I could run one most people are using, then it would be easier to ask questions.


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [ha-guide] No HA Guide team meeting today

Like many, I'm still in recovery mode from last week's Summit. Too many
emails to delete.
The HA Guide team will not meet today.

See you next week at the next HA Guide meeting!

Thursday, June 4 at 8:00 pm UTC on #openstack-meeting-3
https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update#Next_Meeting

Best,
Matt


Matt Griffin
Director of Product Management
Percona
irc: mattgriffin
skype: thebear78
m: 1-214-727-4100

OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Re: [OpenStack-docs] move of documentation-related wiki content (was: Re: Wrapup - Liberty Design Summit)

On 2015-05-28 19:24:15 +0200 (+0200), Christian Berendt wrote:
[...]

If we confirm to move the content into the already existing
developers guide what do we have to do to proceed?

Seems like a great idea for anything that's a fit. Just keep in mind
that we want to keep infra-manual focused on topics that are
relevant to community infrastructure interactions for the majority
of project-teams in our ecosystem, and not drill down into workflow
recommendations which only apply to some specific projects. For one
thing, the Infra team doesn't want to become a review bottleneck for
individual project-team documents.

I think we have to write a spec for docs-specs and I think we
should discuss this topic with the owner of the developers guide
(openstack-infra mailinglist?).

I'm happy to respond here, but yes you might reach more of the
infra-manual authors on the -dev or -infra MLs.
--
Jeremy Stanley


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 05/28/2015 09:03 PM, Jeremy Stanley wrote:
Seems like a great idea for anything that's a fit. Just keep in mind
that we want to keep infra-manual focused on topics that are
relevant to community infrastructure interactions for the majority
of project-teams in our ecosystem, and not drill down into workflow
recommendations which only apply to some specific projects. For one
thing, the Infra team doesn't want to become a review bottleneck for
individual project-team documents.

This is exactly the "problem" I have with the developers guide. Not with
the guide itself, with moving our content in this guide, because the
guide is part of the infrastructure user manual. It is a openstack-infra
specific guide maintained by openstack-infra and the focus of this guide
is focused on "community infrastructure interactions". If we now start
to add generic content or doc related content to this guide the focus of
the guide itself will be changed.

Maybe it is better to move the developers guide out of the
infrastructure user manual into a generic contributor guide published on
developer.o.o? There are other guides inside the infrastructure user
manual not directly related to openstack-infra ("Learn the Gerrit
Workflow in the Sandbox", "Core Reviewer’s Guide", "Python Developer’s
Guide").

Christian.

--
Christian Berendt
Cloud Solution Architect
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Fwd: [openstack-dev] [all] Proper escalation venues for stuck reviews

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Forwarding, because it's an important reminder of how to treat each
other on reviews, and I don't want anybody to miss it.

Remember: be kind, be helpful.

L

  • -------- Forwarded Message --------
    Subject: [openstack-dev] [all] Proper escalation venues for stuck reviews
    Date: Thu, 28 May 2015 17:12:07 -0700
    From: Stefano Maffulli stefano@openstack.org
    Reply-To: OpenStack Development Mailing List (not for usage questions)
    openstack-dev@lists.openstack.org
    To: openstack-dev@lists.openstack.org

First of all a reminder to everybody doing code reviews:

Avoid sarcasm and jokes

Those travel poorly across TCP/IP and don't translate well in different
languages. Just don't use them.

If you get a negative vote or comments you don't like/understand ask for
more explanations. Offer a place and venue to discuss it more. IRC chat
or phone conversation (followed by written resolution on the review
itself) will go a long way to clarify things.

If you're giving a negative comment, offer a place and venue to
discuss it more, like above.

If the disagreement persists, simply agree to disagree: nobody ever
changes their mind based on someone else repeating the same thing over
and over. The way to move the conversation forward is to escalate to
PTLs and the Developer Advocate/Community Manager.

Friendly yours,
Stef


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

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVZ8iLAAoJELppzVb4+KUyu9gH/AsuCabDIgVtAEYRci7/bTKF
I9x4HMH3ARCr/Vri9IyYDbjVp5ZcenvymJXjJc1olIkPUTff4YANDjWPsqMnaC5h
g55+9mL3Sqsv7uxXOAbRt2uUJ+fSaDg2NsIfpSZroRDxr2PPHzXWO0yDCYyAmmUP
5/9VMHGraBeDD6jjaXa2wcby+lctDjpthgD2ckxDUiSHSHW8c9jbh4wEIazMvNma
gRVIFB96yHivphe9XEP32vFL0+rJjRl92Y53JG8OSGH0deTfANhBmRed01wGgtGX
ID68DOvlutOWzA0Mpiy6D3rSa4o6RHOnn8GSs6oAjBIuP4ejLcqGS88yh4157qs=
=GHhn
-----END PGP SIGNATURE-----


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] What's Up, Doc? 29 May 2015

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi everyone,

Continuing in Anne's fine tradition, I intend to send these out every
Friday. If you have content you would like to add, or you would like to
be added to the distribution list, please email me directly at
openstack@lanabrindley.com. I've also decided to start drafting these
'in the open' (as it were). If you want to see my early drafts and
typos, or check on old newsletters, you can do so here:
https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

=== Design Summit ===

The Design Summit was a great success. We had ten sessions for docs
overall, including two workgroups and a contributors' meetup. Thanks to
everyone who came along (or participated remotely!) and had their say on
the Liberty release. I've been spending time gathering my thoughts after
the Summit, and have summarised the etherpad notes on the wiki here:
https://wiki.openstack.org/w/index.php?title=Documentation/Liberty You
can also see the original etherpads here:
https://wiki.openstack.org/wiki/Design_Summit/Liberty/Etherpads#Documentation

In short, the main things I would like us to achieve for Liberty are:
* RST conversion: Install Guide, Cloud Admin Guide, HA Guide
* User Guides information architecture overhaul.
* Greater focus on helping out devs with docs in their repo
* Improve how we communicate with and support our corporate contributors

If you have a burning issue that didn't get addressed during the Summit,
or that you think I've forgotten, now would be your chance to tell me
about it! Look out for Blueprints and Specs for this work over the next
couple of weeks.

=== RST Migration ===

The next books we are focusing on for RST conversion are the Install
Guide, Cloud Admin Guide, and the HA Guide. If you would like to assist,
please get in touch with the appropriate speciality team.

=== New Core Reviewer Process ===

One of the simpler changes I was asked to implement at the Design Summit
was a new core reviewer process, with the aim of making it a more
balanced approach to selecting core team members. We decided on a
process that combines a monthly statistics-based selection process with
a continuous nomination-based process. I've written up the details on
the HowTo here:
https://wiki.openstack.org/wiki/Documentation/HowTo#Achieving_core_reviewer_status
and will implement the first round on 1 June.

=== Doc team meeting ===

APAC meeting was held this week, see the minutes here to catch up:
https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-05-27

Thanks to Joe for holding the APAC fort while I was travelling!

Next meetings are:
US: Wednesday 3 June, 14:00:00 UTC
APAC: Wednesday 10 June, 00:30:00 UTC

Please go ahead and add any agenda items to the meeting page here:
https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

Thanks!
Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVZ8zbAAoJELppzVb4+KUyRo4H/256BF1RUL+or3lh8GSNSTGM
YZLYem1eN4cywwcjWfcwHThXvHG8wpBbW8eoZ7wTKLrVXStiYuxZOM7qPg9QZZAx
NLj+GCcNl96HGCjczCqT7M0N41uKQKLXAJTdUCFmUvvapG7sTfQQyI0HYV24H3Lz
EDxhQN1efA7SPAgspP25iv3bNueAAcZI3JcXhz3TSRhBZVfOIcOL6a04fy1tU/RX
WKY+njHd3Nyg4qoiX37Nn17Op+DzNZEsiF40OiwQ5/Diwxz+UWD3DWXIX0huuRxT
yhWn1Yo31iiQy0dGSabXlTX1E6hWAnwT9dhvBJUrhgusuN7Tq5mzNT1tza6XJs0=
=ZrQH
-----END PGP SIGNATURE-----


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Style Question for Project Names

Hi All,

I am hoping this isn't secretly a hot button issue -- in our Conventions
page
(
https://wiki.openstack.org/wiki/Documentation/Conventions#OpenStack.2C_not_Openstack_or_openstack)
it says that the capitalization of the project team names (like swift,
nova, heat) are lowercase. It lists the official capitalization as
lowercase and further spells out that "When used as a command-line-client
name, lowercase is best. When used for the team or project name, typically
it's not necessary to capitalize."

I think that we should revise this convention so that team and project
names typically start with a capitalized letter. For example Cinder,
Neutron, Glance.
Reasons:
* The community seems to have embraced this style choice.
* This is a logical choice as it is a proper noun.
* It minimizes confusion if a reference is for project name or
command-line interface name.

How does the "change a convention" process work?

Thanks,
Amanda


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On Fri, May 29, 2015 at 9:07 AM, APlimpton aplimpton@gmail.com wrote:

Hi All,

I am hoping this isn't secretly a hot button issue -- in our Conventions
page
(
https://wiki.openstack.org/wiki/Documentation/Conventions#OpenStack.2C_not_Openstack_or_openstack)
it says that the capitalization of the project team names (like swift,
nova, heat) are lowercase. It lists the official capitalization as
lowercase and further spells out that "When used as a command-line-client
name, lowercase is best. When used for the team or project name, typically
it's not necessary to capitalize."

I think that we should revise this convention so that team and project
names typically start with a capitalized letter. For example Cinder,
Neutron, Glance.
Reasons:
* The community seems to have embraced this style choice.
* This is a logical choice as it is a proper noun.
* It minimizes confusion if a reference is for project name or
command-line interface name.

How does the "change a convention" process work?

Well, you started in the right place by bringing it to the mailing list.

I think that you'll have to gather consensus here, then also be willing to
change it everywhere. That's a lot of change in openstack-manuals and other
official documents. In the developer docs I'm sure they use the team names
in ways we wouldn't approve.

I personally strongly argue to eliminate team names to avoid confusion. Try
hard not to ever ever use them in documentation. It's awful to have to look
up a list of names and map to what the service actually is or does. The
names are meaningless, chosen by random lookkups, and get changed due to
trademarking issues, such as quantum/neutron, marconi/zaqar so far.

I dislike deep diving on convention arguments so I'll stop here, but just
wanted to let you know the process and my "feels" on this particular issue.
:)
Thanks,
Anne

Thanks,
Amanda


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

--
Anne Gentle
annegentle@justwriteclick.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] [install guide] Trove and sahara chapters in Juno

Should we remove the trove and sahara chapters from the Juno version of the
installation guide for the same reasons that we removed them from Kilo?
Removal would reduce bug reports for things we can't fix.


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 05/30/2015 05:00 PM, Matt Kassawara wrote:
Should we remove the trove and sahara chapters from the Juno version of
the installation guide for the same reasons that we removed them from
Kilo? Removal would reduce bug reports for things we can't fix.

+1. I never tested Trove/Sahara with the Juno installation guide and the
documented instructions are probably broken.

Christian.

--
Christian Berendt
Cloud Computing Solution Architect
Mail: berendt@b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[OpenStack-docs] Fwd: [Openstack-operators] [Tags] Tags Team Repo & our first tags!

Documentation team,

Please have a look at the install-guide tag since this relates to our
Install Guide.

Tom, if Docs delivers this, then this tag should be owned by
Documentation, shouldn't it?

Andreas

-------- Forwarded Message --------
Subject: [Openstack-operators] [Tags] Tags Team Repo & our first tags!
Date: Mon, 01 Jun 2015 16:07:33 +0800
From: Tom Fifield tom@openstack.org
To: OpenStack Operators openstack-operators@lists.openstack.org

Hi all,

Thank you very much for officially kicking off the Ops Tags Team at the
Vancouver summit!

Based on our discussions, I've made a bit of progress. We now have a

... and ... a first attempt at writing up those tags we discussed at the
meeting:

Please jump on the code review system and add your comments!

Regards,

Tom


OpenStack-operators mailing list
OpenStack-operators@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

On 01/06/15 16:31, Andreas Jaeger wrote:
Documentation team,

Please have a look at the install-guide tag since this relates to our
Install Guide.

Tom, if Docs delivers this, then this tag should be owned by
Documentation, shouldn't it?

Though the value of the tag for a project would ideally be decided in
collaboration with the docs team, this tag is owned by the Ops Tags
Team, who will take responsibility for its ongoing maintenance.

Feedback welcome on the review!

Andreas

-------- Forwarded Message --------
Subject: [Openstack-operators] [Tags] Tags Team Repo & our first tags!
Date: Mon, 01 Jun 2015 16:07:33 +0800
From: Tom Fifield tom@openstack.org
To: OpenStack Operators openstack-operators@lists.openstack.org

Hi all,

Thank you very much for officially kicking off the Ops Tags Team at the
Vancouver summit!

Based on our discussions, I've made a bit of progress. We now have a

... and ... a first attempt at writing up those tags we discussed at the
meeting:

Please jump on the code review system and add your comments!

Regards,

Tom


OpenStack-operators mailing list
OpenStack-operators@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

[openstack-dev] What's Up, Doc? 5 June 2015

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi everyone,

With our Kilo branch now cut, we're running headlong into the Liberty
development cycle! And don't forget to have your say on what the M
release should be called:
https://wiki.openstack.org/wiki/Release_Naming/M_Proposals

If you have content you would like to add, or you would like to be added
to the distribution list, please email me directly at
openstack@lanabrindley.com. I've also decided to start drafting these
'in the open' (as it were). If you want to see my early drafts and
typos, or check on old newsletters, you can do so here:
https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

== Progress towards Liberty ==

== Kilo Branching ==

Thanks to Andreas, Anne, and Tom for getting the Stable/Kilo branch
completed this week. With this, Kilo is now complete* and patches for
the Install Guide and the Config Reference will now be against Liberty
unless you specifically backport a change to Kilo. You can do this by
committing to master with the line ''Backport: Kilo'' in your commit
message. Remember that all other book are continuously integrated, and
this isn't necessary.

[*] Anne: feel free to go have a lie down ;)

== RST Migration ==

The next books we are focusing on for RST conversion are the Install
Guide, Cloud Admin Guide, and the HA Guide. If you would like to assist,
please get in touch with the appropriate speciality team.

For books that are now being converted, don't forget that any change you
make to the XML must also be made to the RST version until conversion is
complete. Our lovely team of cores will be keeping an eye out to make
sure loose changes to XML don't pass the gate, but try to help them out
by pointing out both patches in your reviews.

== New Core Reviewer Process ==

We did our first monthly round of Core Team review this week, and would
like to welcome our newest core team member, Darren Chan. We also bid a
fond farewell to Summer Long and Bryan Payne, who have been great core
team members and contributors, but have now moved on to other
adventures. We sincerely thank them both for their commitment over the
time they were core.

The new core process is documented here:
https://wiki.openstack.org/wiki/Documentation/HowTo#Achieving_core_reviewer_status
The next round will be around 1 July.

== Doc team meeting ==

The US meeting was held this week, see the minutes here to catch up:
https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-06-03

Thanks Shilla for running the US team meeting!

Next meetings are:
APAC: Wednesday 10 June, 00:30:00 UTC
US: Wednesday 17 June, 14:00:00 UTC

Please go ahead and add any agenda items to the meeting page here:
https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

Thanks!
Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVcQZ4AAoJELppzVb4+KUy7D4H/jgU9I9eC6MNSpCrW6AYMPsi
AKmBP+ZiTtXm3iVk1EapzhTUXYINJBtSgP8LfO2QpofqJdbU8KW9f4oIMno86W3G
1GpfGwoFDxLPDDvamxHNNgdihxQRojD7rZE+TspMZV0LU5O5vu3O1JsgNq4268H1
iLncfmfSDLFUU2qbLco6MuNqjK8kSG3U3GoafnPjJTQ4q4/hG5UW6iWSKeHAAay9
VnQ2e06mzOKFWGigcW4gZ8yTtW/kWmzuLcLsC8CAphely7Ru3jdwHH9BJsNdk7+V
zhtTVvB4U8D45SHcrJ5sL2VFeuVWxpbeBNLsY2iz19OhSA10FNHUMPKUgE0a2Ow=
=G7yE
-----END PGP SIGNATURE-----


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

[openstack-dev] What's Up, Doc? 26 June 2015

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi everyone,

First of all, our M release has been named! Sadly, it hasn't cleared
legal yet, so we can't publicly announce it, however, here are the poll
results:
http://civs.cs.cornell.edu/cgi-bin/results.pl?id=E_4983776e190c8dbc It
was a close-run contest!

This week, I've been continuing to dust off some old bugs, and have been
chatting to a few of our docs liaisons to work out how we can best get
them engaged with what we're working on. I've also been spending a lot
of time on standards questions, and thinking about the future of the
DocImpact flag.

== Progress towards Liberty ==

  • RST conversion:
    ** Install Guide: Conversion is now ready to start, sign up here:
    https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
    ** Cloud Admin Guide: is chugging along. Sign up here:
    https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration
    ** HA Guide: is also underway. Get in touch with Meg or Matt:
    https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update
    ** Security Guide: In planning. Stand by for more info.

  • User Guides information architecture overhaul
    ** Waiting on the RST conversion of the Cloud Admin Guide to be complete

  • Greater focus on helping out devs with docs in their repo
    ** Work has started on the Ironic docs, we're now trying to resolve some
    issues with service name standards ("Bare Metal" or "Bare metal"?).
    Contact me if you want to know more, or are willing to help out.

  • Improve how we communicate with and support our corporate contributors
    ** No progress this week

  • Improve communication with Docs Liaisons
    ** I'm very pleased to see liaisons getting more involved in our bugs
    and reviews. Keep up the good work!

  • Clearing out old bugs
    ** Thanks to Yusuke-san for closing bug 1330005!

== RST Migration ==

The next books we are focusing on for RST conversion are the Install
Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would
like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you
make to the XML must also be made to the RST version until conversion is
complete. Our lovely team of cores will be keeping an eye out to make
sure loose changes to XML don't pass the gate, but try to help them out
by pointing out both patches in your reviews.

== Docs Tools ==

Andreas and Nick just released openstack-docs-tools 0.29.1, after we
discovered an RST translation bug in 0.29. Thanks for the quick
turnaround on that!

== Documentation Standards ==

There's been quite a lot of conversation this week over capitalisation
of service names, with the community divided down the middle as to which
we prefer! While we all enjoy a good style discussion, I've also asked
Anne (in her role on the TC) to confirm the legal restrictions for us.
Watch this space! In the meantime, continue to discuss this on the
mailing list :)

== Docs Liaisons ==

Don't forget that we have subject matter experts to help you with
documentation questions that you might have. One of the best ways to get
our liaisons' attention is to add them to a bug or a patch. Feel free to
look up the liaison for the project you're working with, and add them to
the cc list for your patch:

https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation

== Doc team meeting ==

The APAC meeting was held this week, see the minutes here to catch up:
https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-06-24

Next meetings are:
US: Wednesday 1 July, 14:00:00 UTC (note that this has NOT changed with
daylight savings time)
APAC: Wednesday 8 July, 00:30:00 UTC

Please go ahead and add any agenda items to the meeting page here:
https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

== Spotlight bugs for this week ==

Of the three bugs we spotlighted last week, one of them was closed
(thanks Yusuke-san!), and the other two are still up for grabs. Olga is
working on a Spotlight bug from last week, too. Let's keep the momentum,
with another three sad old bugs that could use some love:

https://bugs.launchpad.net/openstack-manuals/+bug/1212349 vmware
documentation

https://bugs.launchpad.net/openstack-manuals/+bug/1212687 xenapi

https://bugs.launchpad.net/openstack-manuals/+bug/1239308 Add
notifications for groups and roles


Remember, if you have content you would like to add to this newsletter,
or you would like to be added to the distribution list, please email me
directly at openstack@lanabrindley.com, or visit:
https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVjOGvAAoJELppzVb4+KUy+3EH/RkUHZwCY6VS43k36x/d0ue9
Zl2Y8d9OJPZwElmhQ7Zl+LOpM1k+vpYDJs6WiCGiGsLVdg8tJX6bdoW1QZwH6+dV
d2qR0yOitQ1/Z2W8y2EK6yAjMmLy7GU3fQBVi742A3g7V0FtbSduCEUwEWBdAv6A
hIMY5nr5nXX0X0oiDro6XcdgHHLtIaFLpumbLE8AcPoYlAauaSjNyT7o4vKqz26u
GxHioUtizv/G+fYWjeejQ3wFGRRbIU5H18h5ohPF4tPlUBKn3pHL7w9RCkzj/993
lJQh3fi4ONwIU0c5tHmqolXAAiWvzROf/l6da1BtSQeSp4qwR2XN+KcsZBQ1V/4=
=Bq+e
-----END PGP SIGNATURE-----


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

[openstack-dev] What's Up, Doc? 10 July 2015

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi everyone,

First of all, apologies for my absence over the past couple of weeks. I
took some time off to spend with my daughter while she was on school
holidays, and then got ill! It never rains but it pours ;) While I was
out, our M release was named, and then unnamed, and we're now waiting
for a new name. We also had a great discussion about which networking
scenario is the best fit for our new-and-improved Installation Guide,
and planned a sprint to get the RST conversion for that book happening.
More on that in this newsletter.

== Progress towards Liberty ==

  • RST conversion:
    ** Install Guide: Conversion is now underway, sign up here:
    https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
    ** Cloud Admin Guide: is nearly done. Sign up here:
    https://wiki.openstack.org/wiki/Documentation/Migrate#Cloud_Admin_Guide_Migration
    ** HA Guide: is also underway. Get in touch with Meg or Matt:
    https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update
    ** Security Guide: In planning. Stand by for more info.

  • User Guides information architecture overhaul
    ** Waiting on the RST conversion of the Cloud Admin Guide to be complete

  • Greater focus on helping out devs with docs in their repo
    ** Work has started on the Ironic docs, we're now trying to resolve some
    issues with service name standards ("Bare Metal" or "Bare metal"?).
    Contact me if you want to know more, or are willing to help out.

  • Improve how we communicate with and support our corporate contributors
    ** I have been brainstorming ideas with Foundation, watch this space!

  • Improve communication with Docs Liaisons
    ** I'm very pleased to see liaisons getting more involved in our bugs
    and reviews. Keep up the good work!

  • Clearing out old bugs
    ** Sadly, no progress this week.

== RST Migration ==

The next books we are focusing on for RST conversion are the Install
Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would
like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you
make to the XML must also be made to the RST version until conversion is
complete. Our lovely team of cores will be keeping an eye out to make
sure loose changes to XML don't pass the gate, but try to help them out
by pointing out both patches in your reviews.

== Install Guide RST Conversion Sprint ==

In order to kick off the RST conversion of the Install Guide, the
speciality team have decided to run a virtual conversion sprint over two
days on July 22-24. For more information, see the
https://wiki.openstack.org/wiki/VirtualSprints#Installation_guide_conversion_from_DocBook_to_RST
wiki page, and the
https://etherpad.openstack.org/p/installguide-rst-virtual-sprint etherpad.

== New core team ==

The core team have just completed our review for July, and would like to
welcome two new core contributors: Alexandra Settle, and Olena
Logvinova. Congratulations to you both :)

== Doc team meeting ==

The APAC meeting was cancelled this week, our next meetings are:

US: Wednesday 15 July, 14:00:00 UTC (note that this has NOT changed with
daylight savings time)
APAC: Wednesday 22 July, 00:30:00 UTC

Please go ahead and add any agenda items to the meeting page here:
https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

== Spotlight bugs for this week ==

Sadly, even with an extra week, our three spotlight bugs remain unloved.
I'm going to keep them here for another week, so now is your chance to
swoop in and make a difference!

https://bugs.launchpad.net/openstack-manuals/+bug/1212349 vmware
documentation

https://bugs.launchpad.net/openstack-manuals/+bug/1212687 xenapi

https://bugs.launchpad.net/openstack-manuals/+bug/1239308 Add
notifications for groups and roles


Remember, if you have content you would like to add to this newsletter,
or you would like to be added to the distribution list, please email me
directly at openstack@lanabrindley.com, or visit:
https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVnyqlAAoJELppzVb4+KUy2S4H/3dhgq6wspQhEYBTBvSc2n3k
LJt9DjOBhCPfZk/hBTuDYRmrQw4os+URwFmUiQTAgeuTF6HEyGnHZ/19bY3eEYVL
Hv271jMPlTIp1CmzVoMflmWEO6ppIstcZQEJLbJnu6xkN9n9uT+mQKtomplsypt6
sLptEBilSnr/ZLYPutrsGioMQrn8w7LMSFQvr56br0z0pr3CG8oZxktsFYC6GbM/
HuRqPnRLSUI1y54ieH/t0QwR+89rKP0OwTqkON53flA3SwPddduo9GEvQm33uZUx
1TdWeHG70dXIwEArvYncQ+9dHsQ7XGtBztdnpD6p5/YzesQC4VwXhteBpGezVs4=
=zYRD
-----END PGP SIGNATURE-----


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

[openstack-dev] What's Up, Doc? 17 July 2015

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi everyone,

I'm very pleased to announce that we finally have a name for our M
release: Mitaka (三鷹)! Accordingly, the Tokyo Summit for the Mitaka
release is only just over 100 days away. CFP closed a couple of days
ago, and I've noticed that the first round of ATC discount codes have
gone out. If you haven't got yours yet, then keep patching Liberty and
sit tight. The discount codes will come out in stages after every
snapshot. This week, we've had some great discussions about networking
scenarios in the Install Guide, and the best way to include RST files in
our newly converted books. We also have both the HA Guide and the Cloud
Admin Guide conversions in their final stages, and the Install Guide
conversion sprint coming up. Very exciting!

== Progress towards Liberty ==

== RST Migration ==

The next books we are focusing on for RST conversion are the Install
Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would
like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you
make to the XML must also be made to the RST version until conversion is
complete. Our lovely team of cores will be keeping an eye out to make
sure loose changes to XML don't pass the gate, but try to help them out
by pointing out both patches in your reviews.

== Install Guide RST Conversion Sprint ==

In order to kick off the RST conversion of the Install Guide, the
speciality team have decided to run a virtual conversion sprint over two
days on July 22-24. For more information, see the
https://wiki.openstack.org/wiki/VirtualSprints#Installation_guide_conversion_from_DocBook_to_RST
wiki page, and the
https://etherpad.openstack.org/p/installguide-rst-virtual-sprint etherpad.

== HA Guide Works ==

With the RST conversion on the HA Guide wrapping up, the HA Guide
speciality team are looking for people to help out with the
reorganisation and writing the new content. They have quite a few bugs
to get through, and they need your help! Contact Matt Griffin, or any
other member of the HA Guide Speciality Team, or join their weekly IRC
meeting. Details here:
https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update

== Docs Tools ==

Last week, we released openstackdocstheme 1.1.0, see
http://lists.openstack.org/pipermail/openstack-announce/2015-June/000392.html.
The main new features in this release are improvements for bug
reporting, variable lists like the glossary are now indented, and
next/prev links are now icons on the upper right part of the page.

Additionally, the stable/icehouse branch of openstack-manuals has been
EOLed, no further updates will be done from it. For more information, see
http://lists.openstack.org/pipermail/openstack-infra/2015-July/002888.html

== Doc team meeting ==

The next meetings are:

APAC: Wednesday 22 July, 00:30:00 UTC
US: Wednesday 29 July, 14:00:00 UTC

Please go ahead and add any agenda items to the meeting page here:
https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

== Spotlight bugs for this week ==

We've now got people assigned to work on last week's old bugs, which is
great! Here are three more rusty old bugs that could use some love:

https://bugs.launchpad.net/openstack-manuals/+bug/1241116 Using policies
for protected properties

https://bugs.launchpad.net/openstack-manuals/+bug/1241179 Add
notifications for groups and roles

https://bugs.launchpad.net/openstack-manuals/+bug/1251060 Xenapi: Allow
windows builds with xentools 6.1 and 6.2


Remember, if you have content you would like to add to this newsletter,
or you would like to be added to the distribution list, please email me
directly at openstack@lanabrindley.com, or visit:
https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVqJabAAoJELppzVb4+KUyDkoIAKIiNrURthUi+Dzj86zkfQHA
dKOHDBIfGmeDgQ059EE+oiuJI8qM+xqvz7zTXAGFhMDzEQ4rfx1lJd6UWwyohwdJ
80hNK696YjsKIIHelN+7zFuzG6jdWHtx9mdVLbnaBU+k0HYDRIEmkyIlRw9WIJRD
YKCRvvijN0Dgwj5EQoyFYSM3/6BQlO1jyX2qf8zUkTjbKKr5d1yJqAnzAXEz0rD0
Hwa7CKVJXaxs1dIF9kdgYFqp+tUHfCRnfD8kQ+CgDpZiZmraXe8mgXFCoSufKCxW
FkqfADfnRWHywnC/G9EtlOWdy8tLsM2CB7GZcicvVIAYIRa3ws/xy6JI/C/fsRU=
=4chR
-----END PGP SIGNATURE-----


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

[openstack-dev] What's Up, Doc? 24 July 2015

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi everyone,

Wow! What a great week for RST conversion patches! As I write this,
there are only a handful of outstanding sections on the Cloud Admin and
HA Guides, and well over 40 sections have now been converted on the
Install Guide, with the conversion sprint running for another twelve
hours or so. Thank you to everyone who has taken the time to grab a
section and do a conversion, and to all those people who have given
their +1 to a patch. I can't wait to see all our shiny new books up on
docs.openstack.org :)

== Progress towards Liberty ==

== RST Migration ==

The next books we are focusing on for RST conversion are the Install
Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would
like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you
make to the XML must also be made to the RST version until conversion is
complete. Our lovely team of cores will be keeping an eye out to make
sure loose changes to XML don't pass the gate, but try to help them out
by pointing out both patches in your reviews.

== HA Guide Works ==

With the RST conversion on the HA Guide wrapping up, the HA Guide
speciality team are looking for people to help out with the
reorganisation and writing the new content. They have quite a few bugs
to get through, and they need your help! Contact Matt Griffin, or any
other member of the HA Guide Speciality Team, or join their weekly IRC
meeting. Details here:
https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update

== Docs Tools ==

While they're not strictly docs tools, I wanted to mention review
dashboards here today. Did you know that we maintain a list of custom
OpenStack review dashboards for you to use? They're customised to show
only the reviews you care about, which can save you a lot of time and
needless clicking. All you need to do is pick the dashboard you want to
use, copy the URL, and save it to your bookmarks. Anne has just updated
the Docs Review Inbox dashboard to include DocImpact reviews, so it's
worth checking out:
http://ghostcloud.net/openstack_gerrit_dashboards/dashboard_doc-program.html
You can see the full list here:
http://ghostcloud.net/openstack_gerrit_dashboards/

== APAC Docs Swarm ==

The APAC team have been working on holding another doc swarm, this time
working on the Architecture Design Guide. It's to be held at the Red Hat
office in Brisbane, on 13-14 August. Check out
http://openstack-swarm.rhcloud.com/ for all the info.

== Doc team meeting ==

The APAC docs meeting was held this week, catch up on the minutes here:
https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-07-22

The next meetings are:
US: Wednesday 29 July, 14:00:00 UTC
APAC: Wednesday 5 August, 00:30:00 UTC

Please go ahead and add any agenda items to the meeting page here:
https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

== Spotlight bugs for this week ==

Giving these three poor old bugs some extra oxygen:

https://bugs.launchpad.net/openstack-manuals/+bug/1241116 Using policies
for protected properties

https://bugs.launchpad.net/openstack-manuals/+bug/1241179 Add
notifications for groups and roles

https://bugs.launchpad.net/openstack-manuals/+bug/1251060 Xenapi: Allow
windows builds with xentools 6.1 and 6.2


Remember, if you have content you would like to add to this newsletter,
or you would like to be added to the distribution list, please email me
directly at openstack@lanabrindley.com, or visit:
https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVsasKAAoJELppzVb4+KUyDJ0H/jZFcRFiwCljVZiNAyGAz1KY
1pb0TF/e42jImw1H89aGXs9QvNIUqDFOuLp+iCWGh5UKPFH/p2R1j1pv3a0lZk8y
dhUjwVEpXJXgW5cFAYSiq3x7yKa8d0HIQtDTsJT78uckR0TbI55IXG8J117fcD3e
yLY4AJNNyX9SGtAUKMy6wdalAdv5+bkKbDfuCPRwOHxfi5Rvy0XWxC+ufvt8muZf
Qt8AiDSsTrLrWyaocunpTU2QA8+EA3cxnKEv/TL2tThuLfAVB3JWmU8pGjiL9fpx
xgt1V+c30hcKQQ+RumcEobuU/zjLCi19VzFH7RaaS3X/FWM0vskmrAApklm3czE=
=P15L
-----END PGP SIGNATURE-----


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

[openstack-dev] What's Up, Doc? 31 July 2015

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi everyone,

This week, like last, was all about the RST conversion. With just a 48
hour long sprint, the Install Guide is almost complete! A hearty
congratulations to everyone who contributed. One of the interesting
things about doing all these conversions is the amount of conversation
it has started about our conventions, and I'm pleased to see that we're
really starting to get a feel for how RST can work for us, and what we
can demand of it. It's also great to see some related changes to the
sphinx theme that handles how we display our shiny RST books.

== Progress towards Liberty ==

75 days to go!

== RST Migration ==

The next books we are focusing on for RST conversion are the Install
Guide, Cloud Admin Guide, HA Guide, and the Security Guide. If you would
like to assist, please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you
make to the XML must also be made to the RST version until conversion is
complete. Our lovely team of cores will be keeping an eye out to make
sure loose changes to XML don't pass the gate, but try to help them out
by pointing out both patches in your reviews.

== Docs Tools ==

Thanks to Dave for picking up a bug this week and adding a navigation
bar to the sidepane of the docs theme for our RST books. We should be
releasing an updated docs theme shortly so you can play with this new
functionality. In the meantime, if you have suggestions for the docs
theme, raise the issue on the docs mailing list, or go right ahead and
create a bug for it.

== APAC Docs Swarm ==

The APAC team have been working on holding another doc swarm, this time
working on the Architecture Design Guide. It's to be held at the Red Hat
office in Brisbane, on 13-14 August. Check out
http://openstack-swarm.rhcloud.com/ for all the info.

== Doc team meeting ==

The US meeting got cancelled this week.

The next meetings are:
APAC: Wednesday 5 August, 00:30:00 UTC
US: Wednesday 12 August, 14:00:00 UTC

Please go ahead and add any agenda items to the meeting page here:
https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

== Spotlight bugs for this week ==

Three new spotlight bugs for you to sink your teeth into:

https://bugs.launchpad.net/openstack-manuals/+bug/1257018 VPNaaS isn't
documented in cloud admin

https://bugs.launchpad.net/openstack-manuals/+bug/1257656 VMware: add
support for VM diagnostics

https://bugs.launchpad.net/openstack-manuals/+bug/1261969 Document nova
server package


Remember, if you have content you would like to add to this newsletter,
or you would like to be added to the distribution list, please email me
directly at openstack@lanabrindley.com, or visit:
https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVuySjAAoJELppzVb4+KUymgUH/Rfh9srfYeY+tzgE1lHm5XW1
USac40LqOOT9TtBtepqxTO3JlqNt5DusYy/TPMp5U0ctqOuzy4UQPPR0WljjBSNe
nV3uspX6CNzhbWGAtF96a5Tv/d7VDyWvc8p8VyHV18dgOk5rgtbO7IixgoFh9tWs
MQoEvhsH3PwK9UTk0+LJZ2qlYX1NCXJH1KeTrqq/uy76EUFGjSfrNHWu4BxmHPhO
hDbpuFMTRM9mvGrYG0gu+tvlOGHMIf3tngPa1Zslhg8Y3xgvSBiCgWeJR1sCokOi
6RVFMMayX+dLU9JEEl6+kIZ4ID+eIvNQErMu/4EfZKlN3S+Y8LroxzF8CZCqCc4=
=0MR8
-----END PGP SIGNATURE-----


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

[openstack-dev] What's Up, Doc? 7 August 2015

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi everyone,

Welcome to August! Today we can finally announce that the Cloud Admin
Guide is now completely converted to RST! I have been doing a fair bit
of 'behind the scenes' work this week, focusing mainly on Training
Guides and our docs licensing. We also welcome another new core team
member this week, and for those of you in the APAC region, get ready for
the Docs Swarm in Brisbane, where we'll be working on restructuring the
Architecture Design Guide.

== Progress towards Liberty ==

68 days to go!

  • RST conversion:
    ** Install Guide: Conversion is nearly done, sign up here:
    https://wiki.openstack.org/wiki/Documentation/Migrate#Installation_Guide_Migration
    ** Cloud Admin Guide: is complete! The new version will be available on
    docs.openstack.org very soon.
    ** HA Guide: is also nearly done. Get in touch with Meg or Matt:
    https://wiki.openstack.org/wiki/Documentation/HA_Guide_Update
    ** Security Guide: Conversion is now underway, sign up here:
    https://etherpad.openstack.org/p/sec-guide-rst

  • User Guides information architecture overhaul
    ** Waiting on the RST conversion of the Cloud Admin Guide to be complete

  • Greater focus on helping out devs with docs in their repo
    ** Work has stalled on the Ironic docs, we need to pick this up again.
    Contact me if you want to know more, or are willing to help out.

  • Improve how we communicate with and support our corporate contributors
    ** I have been brainstorming ideas with Foundation, watch this space!

  • Improve communication with Docs Liaisons
    ** I'm very pleased to see liaisons getting more involved in our bugs
    and reviews. Keep up the good work!

  • Clearing out old bugs
    ** Sadly, no action on the spotlight bugs this week. Perhaps we're all
    worn out from the RST conversions? I'll keep the current three bugs for
    this week, to give everyone a little more time.

== RST Migration ==

With the Cloud Admin Guide complete, we are now working on the Install
Guide, HA Guide, and the Security Guide. If you would like to assist,
please get in touch with the appropriate speciality team:

For books that are now being converted, don't forget that any change you
make to the XML must also be made to the RST version until conversion is
complete. Our lovely team of cores will be keeping an eye out to make
sure loose changes to XML don't pass the gate, but try to help them out
by pointing out both patches in your reviews.

== Training Guides ==

I've been working with the Training Guides group and the docs core team
to determine the best way to move forward with the Training Guides
project. At this stage, we're planning on breaking the project up into a
few distinct parts, and bringing Training Guides back into the
documentation group as a speciality team. If you have any opinions or
ideas on this, feel free to contact me so I can make sure we're
considering all the options.

== APAC Docs Swarm ==

We're less than a week away from the APAC doc swarm! This time we'll be
working on the Architecture Design Guide. It's to be held at the Red Hat
office in Brisbane, on 13-14 August. Check out
http://openstack-swarm.rhcloud.com/ for all the info and to RSVP.

== Core Team Changes ==

This month, we welcome KATO Tomoyuki on to our docs core team. Thanks
for all your hard work Tomoyuki-san, and welcome to the team!

== Doc team meeting ==

The APAC meeting was held this week. Read the minutes here:
https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-08-05

The next meetings are:
US: Wednesday 12 August, 14:00:00 UTC
APAC: Wednesday 19 August, 00:30:00 UTC

Please go ahead and add any agenda items to the meeting page here:
https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

== Spotlight bugs for this week ==

Let's give these three a little more oxygen:

https://bugs.launchpad.net/openstack-manuals/+bug/1257018 VPNaaS isn't
documented in cloud admin

https://bugs.launchpad.net/openstack-manuals/+bug/1257656 VMware: add
support for VM diagnostics

https://bugs.launchpad.net/openstack-manuals/+bug/1261969 Document nova
server package


Remember, if you have content you would like to add to this newsletter,
or you would like to be added to the distribution list, please email me
directly at openstack@lanabrindley.com, or visit:
https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVxFJBAAoJELppzVb4+KUy9d8IAKgEM8succPKaPrmFzY1V5cS
402VF4uR8XzelkkJWQWCG6U1OWP+m6X3n5SFuFraZKLCQmUXL0HG0L3PrLB7eryT
0VKDiGTKcPW5MukLUtKRdkqoyJ5GYWTO6oT3l07tqkCWuGTI5Chp0gcOJDG2spLi
D8BAGAlQ42E+2NqgaxTmU+7uE60CyzXBXsquLcxwnuRr1ih18S5N8Cxkks17XOkL
XSejUisrRVX4lpVdCZw/VdXCBQ6+4YLC9xdnfpPWgXsAc2npPdrUfwju9Tf4JHxF
OmrAQ1igdYDd3KJP4H6tQcIabN5HZuAseOEGZFtWu6bnteyh/1Vz2RI+lUBNo/E=
=TmFH
-----END PGP SIGNATURE-----


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

[openstack-dev] What's Up, Doc? 21 August 2015 (Early edition)

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi everyone,

First of all, apologies for missing last week's newsletter: I got so
caught up in the documentation swarm happening here in Brisbane that it
totally slipped my mind! To make up for it, have this week's newsletter
a day early :) In swarm news, the two days ran extremely smoothly, much
to the credit of Suyog, Brian, and Alex who did the heavy lifting of
preparation and organisation. While we focused largely on copy editing,
we also had a lot of great discussion about the overall architecture of
the book, and now have a draft plan ready for Mitaka, which Darren is
driving with the Ops/Arch Guide speciality team.

While last week was all about the docs swarm, this week has been doing
the final cleanup on our newly converted RST books. The Security Guide
is now up, and the Cloud Admin and HA Guides aren't far behind. We're
also about to start testing the Install Guide, now that its conversion
is complete. Well done to all the people who have helped out on these
efforts, great job!

== Progress towards Liberty ==

55 days to go!

  • RST conversion:
    ** Install Guide: Conversion is done, testing to begin soon.
    ** Cloud Admin Guide: is complete! The new version will be available on
    docs.openstack.org very soon.
    ** HA Guide: is also done, and will available on the site soon.
    ** Security Guide: is complete, and live:
    http://docs.openstack.org/security-guide/

  • User Guides information architecture overhaul
    ** Some user analysis has begun, with a new blueprint to land soon.

  • Greater focus on helping out devs with docs in their repo
    ** Work has picked up on the Ironic docs again.

  • Improve how we communicate with and support our corporate contributors
    ** If you currently work on documentation for a company that would like
    to improve their upstream commits for documentation, please contact me!

  • Improve communication with Docs Liaisons
    ** I'm very pleased to see liaisons getting more involved in our bugs
    and reviews. Keep up the good work!

  • Clearing out old bugs
    ** Sadly, no action on the spotlight bugs again this week. I'll keep the
    current three bugs for this week, to give everyone a little more time.

== RST Migration ==

That's it! We're done!

Do you have ideas for which book should be next? Have a think on it, and
we'll discuss this at Summit.

== Training Guides ==

I'm happy to announce that the Training Labs are now in their own repo,
and are considered a documentation speciality team. Well done to Pranav,
Matjaz, Sayali, and Roger for driving this effort.

== Countdown to Summit ==

With the Liberty release less than two months away, that means it's
nearly Summit time again: https://www.openstack.org/summit/tokyo-2015/

Here's a few things you might want to be thinking about:
* Do you need a visa to visit Japan? If so, you need to be organising
this NOW: https://www.openstack.org/summit/tokyo-2015/tokyo-and-travel/#visa
* Do you have an ATC pass? If you haven't received your pass yet, and
you're an ATC, please contact me so I can chase this up for you.
Remember to use your ATC discount code before 31 August to make sure you
get the full price discounted.

== Doc team meeting ==

The APAC meeting was held this week. Read the minutes here:
https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-08-19

The next meetings are:
US: Wednesday 26 August, 14:00:00 UTC
APAC: Wednesday 2 September, 00:30:00 UTC

Please go ahead and add any agenda items to the meeting page here:
https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

== Spotlight bugs for this week ==

Let's give these three a little more love:

https://bugs.launchpad.net/openstack-manuals/+bug/1257018 VPNaaS isn't
documented in cloud admin

https://bugs.launchpad.net/openstack-manuals/+bug/1257656 VMware: add
support for VM diagnostics

https://bugs.launchpad.net/openstack-manuals/+bug/1261969 Document nova
server package


Remember, if you have content you would like to add to this newsletter,
or you would like to be added to the distribution list, please email me
directly at openstack@lanabrindley.com, or visit:
https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJV1TwWAAoJELppzVb4+KUylDUIALVRDpsMU+xM+7x8AsJKfnwv
BRmGvUQWrrneBdx99b4Dyq/qianUPxz0hHjdchdeA37JfQYGiKoaVWVR1QAj5aPs
WSg5/KRKI8cjHdfGDo7o0NhFIl2d9cyLj55xXap89QWSZvGoRSn8pXIibRoGd+1t
Pp4RpxqftB8BYTlDkrdePYDIb0X+um3CJ2a/0DwuKUUVfn5zWxt9pOBYrYuqyFbK
fUmI0LzRtopT+hmk02eHaefFzq+nQg5RO64osxd3JG/Zibgb8nIqw6eTjMBLvLs8
aPiNQ5ZSi5dwwRfy3pX8XpM4bl9iXOjhEAxtBT+6Zen4MvaTLehXbnoQ+ooETcQ=
=ul61
-----END PGP SIGNATURE-----


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

[openstack-dev] [infra] API docs latest-n-greatest

Hi all,
A couple of notes for API docs this week. One is, the spec to enable RST
builds to developer.openstack.org/api-guide/ merged. The plan is
completely documented here:
http://specs.openstack.org/openstack/docs-specs/specs/liberty/api-site.html

I'm trying to work through the best way to build those while still working
with Russell Sim on the WADL to Swagger converter at fairy-slipper:
https://github.com/russell/fairy-slipper

Basically run migrate.sh and then run_server.sh to see what Swagger can
look like when published (very rough). I'm fixing errors found in the WADL
with migrate.sh as we go and hopefully we can start maintaining Swagger
only before October.
He's working on Issues #4 and #10 but all others are up for grabs:
https://github.com/russell/fairy-slipper/issues

Then, next release we can use our baseline Swagger to ensure the docs get
updated either automatically or manually. If your project already uses
Pecan you may be able to write Swagger with this
https://github.com/elmiko/pecan-swagger.

Some have noted these aren't in the OpenStack git namespace but right now,
the publishing outcome is more important than the governance so we'll get
there when needed.

I'll also put in a formal request here for the infrastructure team to let
us know how to request a server that can serve content on
developer.openstack.org rather than Cloud Sites. I'll attend the Infra team
meeting next week and I've added it to the agenda.
https://wiki.openstack.org/wiki/Meetings/InfraTeamMeeting#Agenda_for_next_meeting

Final note, I've written a set of API docs guidelines in the API Working
Group repository. Please review and offer input, since this guidance
applies for all OpenStack APIs. https://review.openstack.org/#/c/214817/

In summary:
- Please keep the WADL updated for now and continue to fix WADL bugs.
- Take a look at fairy-slipper for the migration and pecan-swagger for
generation.
- Review the API docs guidelines and ask questions.
- With less than 2 months until release, let's git 'er done.

Thanks,
Anne

--
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com


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

在 2015年8月21日,上午9:48,Anne Gentle annegentle@justwriteclick.com 写道:

Hi all,
A couple of notes for API docs this week. One is, the spec to enable RST builds to developer.openstack.org/api-guide/ merged. The plan is completely documented here:
http://specs.openstack.org/openstack/docs-specs/specs/liberty/api-site.html

I'm trying to work through the best way to build those while still working with Russell Sim on the WADL to Swagger converter at fairy-slipper:
https://github.com/russell/fairy-slipper https://github.com/russell/fairy-slipper

Basically run migrate.sh and then run_server.sh to see what Swagger can look like when published (very rough). I'm fixing errors found in the WADL with migrate.sh as we go and hopefully we can start maintaining Swagger only before October.
He's working on Issues #4 and #10 but all others are up for grabs:
https://github.com/russell/fairy-slipper/issues https://github.com/russell/fairy-slipper/issues

Then, next release we can use our baseline Swagger to ensure the docs get updated either automatically or manually. If your project already uses Pecan you may be able to write Swagger with this https://github.com/elmiko/pecan-swagger https://github.com/elmiko/pecan-swagger.

Some have noted these aren't in the OpenStack git namespace but right now, the publishing outcome is more important than the governance so we'll get there when needed.

I'll also put in a formal request here for the infrastructure team to let us know how to request a server that can serve content on developer.openstack.org rather than Cloud Sites. I'll attend the Infra team meeting next week and I've added it to the agenda.
https://wiki.openstack.org/wiki/Meetings/InfraTeamMeeting#Agenda_for_next_meeting https://wiki.openstack.org/wiki/Meetings/InfraTeamMeeting#Agenda_for_next_meeting

Final note, I've written a set of API docs guidelines in the API Working Group repository. Please review and offer input, since this guidance applies for all OpenStack APIs. https://review.openstack.org/#/c/214817/ https://review.openstack.org/#/c/214817/

In summary:
- Please keep the WADL updated for now and continue to fix WADL bugs.
- Take a look at fairy-slipper for the migration and pecan-swagger for generation.
- Review the API docs guidelines and ask questions.
- With less than 2 months until release, let's git 'er done.

Thanks for the summary!

Thanks,
Anne

--
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com __________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: OpenStack-dev-request@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev


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

[openstack-dev] What's Up, Doc? 4 September, 2015

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi everyone,

This has been a fairly busy week, with Summit preparations beginning,
more newly migrated RST books going live, and testing starting on the
Install Guide. I've been spending time on sorting out the Liberty
blueprints still outstanding, and also working on some old bugs.

== Progress towards Liberty ==

40 days to go!

  • RST conversion:
    ** Is now completed! Well done and a huge thank you to everyone who
    converted pages, approved reviews, and participated in publishing the
    new guides. This was a truly phenomenal effort :)

  • User Guides information architecture overhaul
    ** Some user analysis has begun, and we have a new blueprint:
    https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reo
    rganised

  • Greater focus on helping out devs with docs in their repo
    ** A certain amount of progress has been made here, and some wrinkles
    sorted out which will improve this process for the future.

  • Improve how we communicate with and support our corporate contributors
    ** If you currently work on documentation for a company that would like
    to improve their upstream commits for documentation, please contact me!

  • Improve communication with Docs Liaisons
    ** I'm very pleased to see liaisons getting more involved in our bugs
    and reviews. Keep up the good work!

  • Clearing out old bugs
    ** The last lot of old bugs are still languishing. I'm assuming you all
    hate them so very much that I've decided to give you three more to pick
    from. Have at it!

== Countdown to Summit ==

With the Liberty release less than two months away, that means it's
nearly Summit time again: https://www.openstack.org/summit/tokyo-2015/

The schedule has now been released, congratulations to everyone who had
a talk accepted this time around:
https://www.openstack.org/summit/tokyo-2015/schedule/

All ATCs should have received their pass by now, so now is the time to
be booking your travel and accommodation:
https://www.openstack.org/summit/tokyo-2015/tokyo-and-travel/

== Conventions ==

A new governance patch has landed which changes the way we capitalise
service names (I know almost exactly 50% of you will be happy about
this!):
https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_pr
oject_names
Please be aware of this when editing files, and remember that the
'source of truth' for these things is the projects.yaml file:
http://git.openstack.org/cgit/openstack/governance/tree/reference/projec
ts.yaml

== Docs Tools ==

openstack-doc-tools 0.30.0 and openstackdocstheme 1.2.1 have been
released. openstack-doc-tools allows translation of the Install Guide.
openstackdocstheme contains fixes for the inclusion of metatags, removes
unused images and javascript files, and fixes the "Docs Home" link.

== Doc team meeting ==

The APAC meeting was not held this week. The minutes from the previous
US meeting are here:
https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-08-26

The next meetings are:
US: Wednesday 9 September, 14:00:00 UTC
APAC: Wednesday 16 September, 00:30:00 UTC

Please go ahead and add any agenda items to the meeting page here:
https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_
meeting

== Spotlight bugs for this week ==

Let's give these three a little love:

https://bugs.launchpad.net/openstack-manuals/+bug/1280092 end user guide
lacks doc on admin password injection

https://bugs.launchpad.net/openstack-manuals/+bug/1282765 Chapter 6.
Block Storage in OpenStack Cloud Administrator Guide

https://bugs.launchpad.net/openstack-manuals/+bug/1284215 Driver for IBM
SONAS and Storwize V7000 Unified


Remember, if you have content you would like to add to this newsletter,
or you would like to be added to the distribution list, please email me
directly at openstack@lanabrindley.com, or visit:
https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.22 (GNU/Linux)

iQEcBAEBAgAGBQJV6TlFAAoJELppzVb4+KUy/zkIAKYKbKdw78Nv8dpB8d9Rj4qh
+JTK2rTlz/Up5F10OzIoJoNMIvySeKH+jHV1CP0qL9KigYaepkEeMn8RnNSayYww
cgSmk/8gpzGTTd17JK0Rrn+RjOb3XMYeNH2d4OkvIQPGBAYsnerODrvEK3GG7YHO
oo5xYSkLdYH54qnXhhvNZxjxDclT1P5QgpUP6M6KcB3bcKt4niHGLHnBHFoqvlMR
gJA1BtKR6CackhZbkJpPFCpEHimm4xdWwF+q7xRezy599MbkkPAIxR/oMuEkqU2H
zj+tm9sHDxOoH2j4Hfkbw7xxF+/NjvGtm41JCPsUVBxuAocaBbJ1kZRbbRzrafI=
=2TAI
-----END PGP SIGNATURE-----


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

[openstack-dev] What Up, Doc? 11 September, 2015

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi everyone,

Things are really starting to heat up now! Summit preparations are well
underway, PTL elections just opened, and testing is proceeding apace on
the Install Guide. As well as preparing my candidacy for Mitaka Docs
PTL, I've been continuing to sort out the outstanding blueprints, and
also planning for some announcements in Tokyo. One of the interesting
things I learned while compiling a list of Liberty achievements is that
we have released fixes for nearly 500 bugs since Kilo was released. What
an amazing achievement!

== Progress towards Liberty ==

33 days to go

496 bugs closed so far.

  • RST conversion:
    ** Done.

  • User Guides information architecture overhaul
    ** This is now well underway.

  • Greater focus on helping out devs with docs in their repo
    ** A certain amount of progress has been made here, and some wrinkles
    sorted out which will improve this process for the future.

  • Improve how we communicate with and support our corporate contributors
    ** I'm still trying to come up with great ideas for this, please let me
    know what you think.

  • Improve communication with Docs Liaisons
    ** I'm very pleased to see liaisons getting more involved in our bugs
    and reviews. Keep up the good work!

  • Clearing out old bugs
    ** We've had some solid progress on last week's bugs, with two assigned,
    and one of those in progress. Three new bugs this week.

== Mitaka Summit Prep ==

The schedule has now been released, congratulations to everyone who had
a talk accepted this time around:
https://www.openstack.org/summit/tokyo-2015/schedule/

All ATCs should have received their pass by now, so now is the time to
be booking your travel and accommodation:
https://www.openstack.org/summit/tokyo-2015/tokyo-and-travel/

Docs have been given their design summit session allocation, so start
thinking about what you would like to see discussed. I'll send out an
etherpad to start planning in the next week or two.

== Conventions ==

A new governance patch has landed which changes the way we capitalise
service names (I know almost exactly 50% of you will be happy about
this!):
https://wiki.openstack.org/wiki/Documentation/Conventions#Service_and_pr
oject_names
Please be aware of this when editing files, and remember that the
'source of truth' for these things is the projects.yaml file:
http://git.openstack.org/cgit/openstack/governance/tree/reference/projec
ts.yaml

== Doc team meeting ==

The US meeting was held this week. The minutes are here:
https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-09-09

The next meetings are:
APAC: Wednesday 16 September, 00:30:00 UTC
US: Wednesday 23 September, 14:00:00 UTC

Please go ahead and add any agenda items to the meeting page here:
https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_
meeting

== Spotlight bugs for this week ==

Let's show these three how much we care:

https://bugs.launchpad.net/openstack-manuals/+bug/1284301 Document
Neutron SSL-VPN for cloudadmin

https://bugs.launchpad.net/openstack-manuals/+bug/1288044 Add user
defined extra capabilities

https://bugs.launchpad.net/openstack-manuals/+bug/1292327 Make cors work
better


Remember, if you have content you would like to add to this newsletter,
or you would like to be added to the distribution list, please email me
directly at openstack@lanabrindley.com, or visit:
https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.22 (GNU/Linux)

iQEcBAEBAgAGBQJV9km4AAoJELppzVb4+KUyr0kIALxedlQxY0jONXXD+xaPNW76
JPjpnBrBjGyIvq09qeqU4vYVkSq56eF2qPtY6YCKmu0nkjTxAoJX0JxqGyTq3J+H
nPv/+Hyg/VOJaZmJ6Qs3Ij1w9759OLiovnUjh3IsjkkZOXN/uHxw5LZQ3oXhmK+j
Ydui86STbM1OUtOeNcxgH5zGl4aj/SWCrOwARAKXs6K0JShUvvtYmxPnQwvX/Mgn
uLy9976PoboOR6SCW052ZBNT1VKHPOjpCaK3xOf7JJZQYi1V1Uv7BJwpSTBiyYOv
MFvHRETKiWvfbyDKvvR1tYxyQixGq/aQWWcxke14YugEjFZ3wUAoWdwiD0VfXsA=
=52+9
-----END PGP SIGNATURE-----


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

[openstack-dev] What's Up, Doc? 25 September 2015

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi everyone,

First of all, thank you to everyone who has suggested sessions for docs
at Tokyo. I'll keep the etherpad open for another week or so, just to
give everyone a chance, and will start working on a draft schedule next
week. I have spent most of this week on bug triage, which is repetitive
work, but it's gratifying to see the numbers drop a little!

== Progress towards Liberty ==

19 days to go

534 bugs closed so far for this release.

The main areas of focus we had during Liberty were the RST migration,
paying down some of our technical debt, and improving our general
communication issues. The RST conversion is well and truly complete,
with just a couple of books waiting in the wings to be published. We
have made some progress on improving our communication generally, with
liaisons now more visible and involved, and some improved processes.
Regarding old bugs, during Liberty we spotlighted a total of 24 bugs,
exactly half of which have now been closed.

== Mitaka Summit Prep ==

The schedule app for your phone is now available. This is a great tool
once you're on the ground at Summit:
https://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=98721
6292&mt=8
(Apple) and
https://play.google.com/store/apps/details?id=org.sched.openstacksummitm
ay2015vancouver
(Android)

Docs have been allocated two fishbowls, four workrooms, and a half day
meetup, so now is the time to start gathering ideas for what you would
like to see us cover. Add your ideas to the etherpad here:
https://etherpad.openstack.org/p/Tokyo-DocsSessions I'll create a draft
session based on this feedback next week.

== Bug Triage Process ==

The core team have been noticing a lot of people trying to close bugs
that haven't been triaged recently. It is very important that you have
someone else confirm your bug before you go ahead and create a patch.
Waiting just a little while for triage can save you (and our core team!)
a lot of work, and makes sure we don't let wayward changes past the
gate. If you're unsure about whether you need to wait or not, or if
you're in a hurry to work on a bug, you can always ping one of the core
team on IRC or on our mailing list. The core team members are listed
here, and we're always happy to help you out with a bug or a patch:
https://launchpad.net/~openstack-doc-core

This is even more important than usual as we get closer to the Liberty
release, so remember: If it's not triaged, don't fix it!

== Spotlight Bugs ==

During Liberty we spotlighted a total of 24 bugs, exactly half of which
have now been closed. This is a great effort to clear out some old dusty
bugs and pay down some technical debt. Thanks go out to Tom Fifield,
Olga Gusarenko, Yusuke Ide, Brian Moss, Deena Cooper, and Alexandra
Settle for taking them on! With Liberty and the Summit bearing down on
us, though, let's focus back on what needs to be done for release. At
Summit, we'll discuss how to expand and improve on this effort in future
releases.

== Doc team meeting ==

The US meeting was held this week. The minutes are here:
https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-09-23

The next meetings will be the final meetings before the Liberty release:
APAC: Wednesday 30 September, 00:30:00 UTC
US: Wednesday 7 October, 14:00:00 UTC

Please go ahead and add any agenda items to the meeting page here:
https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_
meeting


Remember, if you have content you would like to add to this newsletter,
or you would like to be added to the distribution list, please email me
directly at openstack@lanabrindley.com, or visit:
https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iQEcBAEBAgAGBQJWBNTTAAoJELppzVb4+KUyW6EH/2kYOYHa2DHfHJxN2XC1QcpD
L3wwDWxu9B2G6M/hNzRJ/KELSVikfuK9+ChOA+kD2kXLs6dV1oLXXCbV2KIdHKWP
+EYPG0G/CsMkoq8KIfzYwW6c2k+RzSXZAnI1ZhcRJiwhlIC5JlSZ118Y64GeLxmB
jISEqsi7WdK76caMmEy+3+QrpBY/WNOVE5Dyu0TiwGTPtU1EuZEAXHkdFjczKEKM
azlyyFIF4V28+BjrZpUybarEL2hZerHt2XiNd5dCRoQgE7b8ubJ0cidErPazI9AV
mZNZO3VtLTfSC2ytNBwIBaN3ezJzC5mvba6ofDdej3jIvZf3o6IQihbMaYWyLDI=
=uZBu
-----END PGP SIGNATURE-----


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

[openstack-dev] What's Up, Doc? 2 October

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi everyone,

Welcome to October, which means: it's nearly release day! I've been
brushing up on the release management tasks, and continued my
housekeeping duties to make sure we're in shape. The next two weeks will
be spent watching the Installation Guide pretty closely, and making sure
we get it all tested and ready to ship. If you are looking for something
to do this week, please treat Install Guide testing as your main
priority from here until 15 October. Also, don't forget to vote in the
TC election next week!

== Progress towards Liberty ==

12 days to go

534 bugs closed so far for this release.

The main things that still need to be done as we hurtle towards release:
* Testing, testing, testing:
https://wiki.openstack.org/wiki/Documentation/LibertyDocTesting
* Reviews:
https://review.openstack.org/#/q/status:open+project:openstack/openstack
- -manuals,n,z
and
https://review.openstack.org/#/q/status:open+project:openstack/api-site,
n,z
* Bug triage:
https://bugs.launchpad.net/openstack-manuals/+bugs?search=Search&field.s
tatus=New

== Mitaka Summit Prep ==

Thank you to everyone who provided suggestions for Design Summit
sessions. I've now mangled them into a draft schedule, which looks a
little like this:

Workrooms (Thursday AM):
- - Docs toolchain/infra info session
- - IA working session - Ops/Arch Guides & User Guides
- - Doc Contributor Guide: new content addition
- - API Docs Session

Fishbowls (Thursday PM):
- - The docs process, plus best practices
- - Mitaka planning - deliverables for the next release

Meetup (Friday AM):
- - Contributors meetup. No agenda. We can assist with setting up
devstack/working through the Install Guide during this session

Once I have access to Cheddar and Sched, I'll get this allocated more
accurately. In the meantime, feedback or questions are welcome.

== Bug Triage Process ==

The core team have been noticing a lot of people trying to close bugs
that haven't been triaged recently. It is very important that you have
someone else confirm your bug before you go ahead and create a patch.
Waiting just a little while for triage can save you (and our core team!)
a lot of work, and makes sure we don't let wayward changes past the
gate. If you're unsure about whether you need to wait or not, or if
you're in a hurry to work on a bug, you can always ping one of the core
team on IRC or on our mailing list. The core team members are listed
here, and we're always happy to help you out with a bug or a patch:
https://launchpad.net/~openstack-doc-core

This is even more important than usual as we get closer to the Liberty
release, so remember: If it's not triaged, don't fix it!

== Doc team meeting ==

The APAC meeting was held this week. The minutes are here:
https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-09-30

The next meetings will be the final meetings before the Liberty release:
US: Wednesday 7 October, 14:00:00 UTC
APAC: Wednesday 14 October, 00:30:00 UTC

Please go ahead and add any agenda items to the meeting page here:
https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_
meeting


Remember, if you have content you would like to add to this newsletter,
or you would like to be added to the distribution list, please email me
directly at openstack@lanabrindley.com, or visit:
https://wiki.openstack.org/w/index.php?title=Documentation/WhatsUpDoc

Keep on doc'ing!

Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iQEcBAEBAgAGBQJWDgItAAoJELppzVb4+KUyvy4H/3J5Dg5Z2Rv5yHImXU7ZhY4U
chAQQ8ZUTysKcKtShIvqWqiejOWUql0Y2L9cV+28P9A8NFjJ/meWAckjC+LQgl1X
WrqDimHjtStkLTft0kbmsVN3HYDpdH9QJhLh0ut3YHieWy5DeFaKZGbnP5MrTwFi
7WPjWCChECyCx0olrsr8AoYtLu9wUjtX0rDFJTC/4T3kZ1wauUnkWeRVT4S2e09c
mjpGf7xgkciRqOyFgACzL0dGYXFlQhPxrRAnGMMRjpGERTIkWzlptk5v/oF9rx4v
84B/Ni3eTH2O+uqmVuXzjesvzV27Yzhoq4UvN14SeN7cHJ43mTfVsPi9kUZYPGM=
=aCzp
-----END PGP SIGNATURE-----


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

Re: [openstack-dev] [OpenStack-docs] Networking guide team disintegration

This needs to be brought to the attention of the new PTL for Neutron. The original team that released the networking guide cannot be expected to carry this work forward in perpetuity.

On October 2, 2015, at 6:45 PM, Lana Brindley openstack@lanabrindley.com wrote:

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

I do strongly believe that the Networking Guide needs to be a speciality team all of its own, and not part of a larger team. It's an important part of our documentation suite.

The leader of the team doesn't necessarily need to be doing the lion's share of the work (in fact, in many cases, it's better if you aren't), and you don't need to be a core contributor. You do need to be able to commit to running meetings once a week or every two weeks, and keeping an eye on reviews.

Of course, I am here to support anyone who chooses to take this on, as well.

Lana

On 03/10/15 04:40, Nick Chase wrote:

I'm actually serious on abdicating here; I'm catching up after being good and sick (and theoretically I'm still on sick leave) so it would probably be better if I stepped aside.

Who wants it?

---- Nick

On 10/2/2015 12:06 PM, Anita Kuno wrote:

On 10/02/2015 11:53 AM, Nick Chase wrote:

Agreed.

---- Nick
Having meetings on irc in order to allow new contributors to read some
archives to get up to speed is one of the reasons we encourage projects
to have meetings on irc.

Now we need folks willing to read archives and attend meetings, that is
true, but irc logs can serve as a doorway if we do have any new
contributors who are interested.

Can I suggest networking guide team meetings move to irc?

Thank you, I want to help this group continue and to grow. The work you
do is very important.

Thanks,
Anita.

On 10/2/2015 11:52 AM, Matt Kassawara wrote:

I hope your surgery went well. However, the problems began long before
9/9.

On Fri, Oct 2, 2015 at 9:45 AM, Nick Chase <nchase@mirantis.com
nchase@mirantis.com> wrote:

 I had major surgery on 9/9 and have been on sick leave, I take
 responsibility for falling down on the job there.

 I hereby abdicate if someone else feels they can take it.

 Thanks...

 ---

 On 10/2/2015 11:19 AM, Matt Kassawara wrote:
 I find it extremely unfortunate that the networking guide team
 disintegrated after the initial release of the guide for Kilo. No
 one attends the meetings and no one outside of a couple of people
 make any significant contributions. Furthermore, the guide
 receives little attention from neutron developers who are key to
 keeping the content fresh.

 I suggest we either disband the team or find new leadership for it.


 _______________________________________________
 OpenStack-docs mailing list
 OpenStack-docs@lists.openstack.org
 <mailto:OpenStack-docs@lists.openstack.org>
 http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
 _______________________________________________
 OpenStack-docs mailing list
 OpenStack-docs@lists.openstack.org
 <mailto:OpenStack-docs@lists.openstack.org>
 http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBAgAGBQJWDwjlAAoJELppzVb4+KUy/zUH+gMd2J/2U/AB6WNkLdboGaD+
dl9zB3cZt62KW3xfpWkXJu9RmbfQrymGIaHlZYWb06g49lliUh8aqoQDfwCrENUC
UQIyRD26qUWnxTolh57F2/WUrC64O2xONzgyrOzuWKrVKVuse+A433x0XepYVJod
naqNGlPr5l+vMKRfvS0EFFYP30v8wdITZz3T/8rTo3N1yXu/8WYI7NK8Z54iknoQ
Utocjt6V7hgSC54HYVitld4UbcxXb5ghwMAAkjiF9sz66WXDA86743xdQ10ePyUL
06RTEwquGT097epcDqiHrL5D90Lfok4+P5y1ZkJ1exoZucESlCSn3Af3lK+ZuRg=
=10zx
-----END PGP SIGNATURE-----


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

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

I volunteer to lead this effort. From the very beginning was an idea between Nick and myself and I do have the bandwidth to work on this guide.

There are still a lot of work to do and I will move the meetings to IRC and also to formalize better the team by following all the Foundation policies, guidelines and rules.

Nick,

Thank you so much for all the work invested in this guide. We have achieved a great document and we will miss your input. I am pretty sure you are not going to disappear for sure, at least I will not let you to do that.

I am also in PTO this week but I am back in business this Monday Oct 5th.

Kind Regards,

Edgar

On Oct 3, 2015, at 2:33 PM, Sean Collins sean@coreitpro.com wrote:

This needs to be brought to the attention of the new PTL for Neutron. The original team that released the networking guide cannot be expected to carry this work forward in perpetuity.

On October 2, 2015, at 6:45 PM, Lana Brindley openstack@lanabrindley.com wrote:

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

I do strongly believe that the Networking Guide needs to be a speciality team all of its own, and not part of a larger team. It's an important part of our documentation suite.

The leader of the team doesn't necessarily need to be doing the lion's share of the work (in fact, in many cases, it's better if you aren't), and you don't need to be a core contributor. You do need to be able to commit to running meetings once a week or every two weeks, and keeping an eye on reviews.

Of course, I am here to support anyone who chooses to take this on, as well.

Lana

On 03/10/15 04:40, Nick Chase wrote:
I'm actually serious on abdicating here; I'm catching up after being good and sick (and theoretically I'm still on sick leave) so it would probably be better if I stepped aside.

Who wants it?

---- Nick

On 10/2/2015 12:06 PM, Anita Kuno wrote:

On 10/02/2015 11:53 AM, Nick Chase wrote:
Agreed.

---- Nick
Having meetings on irc in order to allow new contributors to read some
archives to get up to speed is one of the reasons we encourage projects
to have meetings on irc.

Now we need folks willing to read archives and attend meetings, that is
true, but irc logs can serve as a doorway if we do have any new
contributors who are interested.

Can I suggest networking guide team meetings move to irc?

Thank you, I want to help this group continue and to grow. The work you
do is very important.

Thanks,
Anita.

On 10/2/2015 11:52 AM, Matt Kassawara wrote:
I hope your surgery went well. However, the problems began long before
9/9.

On Fri, Oct 2, 2015 at 9:45 AM, Nick Chase <nchase@mirantis.com
nchase@mirantis.com> wrote:

I had major surgery on 9/9 and have been on sick leave, I take
responsibility for falling down on the job there.

I hereby abdicate if someone else feels they can take it.

Thanks...

---
On 10/2/2015 11:19 AM, Matt Kassawara wrote:
I find it extremely unfortunate that the networking guide team
disintegrated after the initial release of the guide for Kilo. No
one attends the meetings and no one outside of a couple of people
make any significant contributions. Furthermore, the guide
receives little attention from neutron developers who are key to
keeping the content fresh.

I suggest we either disband the team or find new leadership for it.


_______________________________________________
OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
<mailto:OpenStack-docs@lists.openstack.org>
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
_______________________________________________
OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
<mailto:OpenStack-docs@lists.openstack.org>
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBAgAGBQJWDwjlAAoJELppzVb4+KUy/zUH+gMd2J/2U/AB6WNkLdboGaD+
dl9zB3cZt62KW3xfpWkXJu9RmbfQrymGIaHlZYWb06g49lliUh8aqoQDfwCrENUC
UQIyRD26qUWnxTolh57F2/WUrC64O2xONzgyrOzuWKrVKVuse+A433x0XepYVJod
naqNGlPr5l+vMKRfvS0EFFYP30v8wdITZz3T/8rTo3N1yXu/8WYI7NK8Z54iknoQ
Utocjt6V7hgSC54HYVitld4UbcxXb5ghwMAAkjiF9sz66WXDA86743xdQ10ePyUL
06RTEwquGT097epcDqiHrL5D90Lfok4+P5y1ZkJ1exoZucESlCSn3Af3lK+ZuRg=
=10zx
-----END PGP SIGNATURE-----


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


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

[openstack-dev] [cross-project] [docs] Cross-Project Docs Session

Hi everybody,

Just a reminder that there is a cross-project workshop at 2pm today with a focus on the documentation project: http://mitakadesignsummit.sched.org/event/f81293c41ef787f53361e408d15caae4#.Vi7fumQrIy4

I’ve started up the etherpad for the session (https://etherpad.openstack.org/p/mitaka-cross-project-documentation-team). The main thing I want to make sure we discuss is packaging, especially in light of the Liberty Install Doc for RDO, but feel free to add your own suggestions for topics as well :)

See you then,
Lana

Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia


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

[openstack-dev] What's Up, Doc? 三鷹 Summit Edition

Hi everyone,

Welcome to the Summit edition of the docs newsletter! Docs have had a wonderfully productive week here in Tokyo, and we've now established a plan for Mitaka. This newsletter covers the more important announcements, and the main points we want to hit in the next release.

Karin has kindly written up the summary of the Design Summit sessions here: https://etherpad.openstack.org/p/Mitaka-Docs-Meetup

== Mitaka Goals ==

This is the list at the moment. There are more notes in the docs etherpads, and not everything has blueprints yet.

== Speciality Team Changes ==

More detail on the Speciality Team wiki page: https://wiki.openstack.org/wiki/Documentation/SpecialityTeams

  • Install Guide is now with Christian Berendt
  • HA Guide is now with Bogdan Dobrelya
  • Networking Guide is now with Edgar Magana
  • New Hypervisor Tuning Guide team with Joe Topjian

あなたの東京ありがとう!

Lana

Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia


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

[openstack-dev] What's Up, Doc? 6 November 2015

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Hi everyone,

Wow! What a great Summit! And isn't Tokyo a truly beautiful and amazing city? Thank you so much to the Japanese Stackers who hosted us, and to everyone who came along to the docs sessions and helped us hammer out a great plan for Mitaka. I'm very excited about this release!

This week, I've been catching up with everything that happened during Summit, and also working on outreach tasks. Today, I recorded an interview with Foundation about the project, and I've also published a blog post on the same topic, which will be published soon. You might also like to check out the Superuser interview Anne and I did about the docs while we were in Tokyo: http://superuser.openstack.org/articles/openstack-documentation-why-it-s-important-and-how-you-can-contribute

== Progress towards Mitaka ==

152 days to go!

77 bugs closed so far for this release.

API Docs
* The API docs are will be switched to swagger: http://specs.openstack.org/openstack/docs-specs/specs/liberty/api-site.html

DocImpact
* I've removed the WIP from this blueprint, and will be working on this from next week: https://blueprints.launchpad.net/openstack-manuals/+spec/review-docimpact

RST Conversions
* Arch Guide
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-rst
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
* Ops Guide
** https://blueprints.launchpad.net/openstack-manuals/+spec/ops-guide-rst
** Lana will reach out to O'Reilly to discuss the printed book before this work begins
* Config Ref
** Thanks for all the offers of help on this one! Please contact the Config Ref Speciality team: https://wiki.openstack.org/wiki/Documentation/ConfigRef

Reorganisations
* Arch Guide
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
* User Guides
** https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised
** Contact the User Guide Speciality team: https://wiki.openstack.org/wiki/User_Guides

Training
* Labs
** https://blueprints.launchpad.net/openstack-manuals/+spec/training-labs
* Guides
** Upstream University & 'core' component updates, EOL Upstream Wiki page.

Document openstack-doc-tools
* Need volunteers for this!

Reorganise index page
* The API docs have already moved off the front page
* We need volunteers to look at the organisation of this page and to write one-sentence summaries of each book

== Doc team meeting ==

Meetings will kick off again next week with the APAC meeting:

APAC: Wednesday 11 November, 00:30:00 UTC
US: Wednesday 18 November, 14:00 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting


Keep on doc'ing!
Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBCAAGBQJWPC4TAAoJELppzVb4+KUynpUH/30Y6pv7Zrse+YM1ki2pqLqi
dp0f9RysJQkvXOA7OWy48kWLWXgMF0/hq1DIhrZ9AlsUCGOGC04/YVGNyaCAxMkx
TTpyi6gJWl9Fiwbrc6k63MPx7OMFDcGu8KQow7tCBewH0jYngiJeP/mxIP6AnhBy
SHVsZZ4OG99w/xZyUe8rVGkpXLFUfow8u0r4hCLlFGSUxLD3jz8ABp2HX7mf3ICi
0u1rgxD08lWSHPHRmhzUZ+kx7uW1ZY0UWiX1rsyTU690dsYbYeJSUcY+Saf2md52
eIGk7yevZaYczXvn9vo/rfwZCc4G5jyRFp55yR/BfD/2NVsjmt2vvguWTnDywEE=
=Y0ik
-----END PGP SIGNATURE-----


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

[openstack-dev] What's Up, Doc? 13 November 2015

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Hi everyone,

Well, things are starting to ramp up again after Summit.

This week, I've spent some time catching up with other PTLs, and also worked on the DocImpact spec. I've also implemented my plan to get the Speciality Team leads to provide content on their projects individually, so many thanks to them for replying with so much great info!

== Progress towards Mitaka ==

145 days to go!

100 bugs closed so far for this release.

DocImpact
* I've updated the spec and made contact with Infra to nut out the finer technical details: https://blueprints.launchpad.net/openstack-manuals/+spec/review-docimpact

RST Conversions
* Arch Guide
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-rst
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
* Ops Guide
** https://blueprints.launchpad.net/openstack-manuals/+spec/ops-guide-rst
** Lana will reach out to O'Reilly to discuss the printed book before this work begins
* Config Ref
** Contact the Config Ref Speciality team: https://wiki.openstack.org/wiki/Documentation/ConfigRef
* Virtual Machine Image Guide
** https://blueprints.launchpad.net/openstack-manuals/+spec/image-guide-rst and https://review.openstack.org/#/c/244598/

Reorganisations
* Arch Guide
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
* User Guides
** https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised
** Contact the User Guide Speciality team: https://wiki.openstack.org/wiki/User_Guides

Document openstack-doc-tools and reorganise index page
* Thanks to Brian for volunteering to take this on!

Horizon UX work
* There's an interesting opportunity to improve the wording in Horizon, specifically around LBaaS, and also to develop a set of standards around the language used in the dashboard. If you're interested, let me know and I'll get you in contact with the right people.

== Speciality Teams ==

'''HA Guide - Bogdan Dobrelya'''
Created a poll to shift HA guide IRC meeting time (http://lists.openstack.org/pipermail/openstack-docs/2015-November/007830.html). Submitted a status for HA guide testing (http://lists.openstack.org/pipermail/openstack-docs/2015-October/007718.html), hoping to see more participants in testing. Trying to push few patches, and initiated related discussion: https://review.openstack.org/#/c/225418/ and https://review.openstack.org/235893. Thinking on how to effectively collaborate with Adam Spiers and his Openstack HA initiative (http://lists.openstack.org/pipermail/openstack-dev/2015-November/079127.html) to benefit HA guide project as well.

'''Installation Guide - Christian Berendt'''
Moved the team meeting from Google Hangout to IRC (online at http://eavesdrop.openstack.org/#Documentation_Install_Team_Meeting), we had our first team meeting on the IRC (http://eavesdrop.openstack.org/meetings/docinstallteam/2015/docinstallteam.2015-11-11-01.03.html), we discussed the inclusion of hypervisor specific appendixes, no consensus at the moment, really good progress on the Debian install guide, zigo is doing a good job.

'''Networking Guide - Edgar Magana'''
We have a new spec for OVN: https://review.openstack.org/#/c/244367/ I am going to start pulling people into specific patches.

'''Security Guide - Nathaniel Dillon'''
We have added a new chapter on Manila and have completed the reworking of the case studies.

'''User Guides - Joseph Robinson'''
Our meeting format has changed from hangouts to IRC meetings, with the appropriate changes made to the meetbot script thanks to Brian. The mitaka specification: the priority at the moment is checking in with project docs liaisons to confirm what services are in scope, and then add a short statement to the specification outlining this scope. Responding to Cloud Admin Guide patches. Thanks to Andreas for the link.

'''Ops and Arch Guides - Shilla Saebi'''
The operations guide RST migration is on hold until we find out if we are going to move forward with docbook or RST. In the meantime we are looking to add content and update it. The architecture guide RST conversion is underway. The progress on chapters and pages can be checked via the wiki page: https://wiki.openstack.org/wiki/Documentation/Migrate

'''API Docs - Anne Gentle'''
Russell Sim plans to revise the templates for developer.openstack.org landing page to better match docs.openstack.org. We'll also map out a plan for fairy-slipper and the WADL migration. Spec to be updated soon.

'''Config Ref - Gauvain Pocentek'''
The initial structure for the Config Reference RST migration is up, the automation tools are ready to handle RST tables generation, and a couple pages have already been converted. We're waiting for the liberty branching to start pushing more converted pages.

'''Training labs - Pranav Salunke'''
Added Kilo support, still under review but in final stages (https://review.openstack.org/#/c/237061/). Halfway through adding KVM support, will probably need more time. Other small things like fixing readmes etc. Still pending to decide IRC meeting time.

'''Training Guides - Matjaz Pancur'''
Two new core reviewers: Kato Tomoyuki and Tim Freund. We also added a new policy for cores: current lead of Upstream training session (held before each Summit) is now part of the core team by function.

'''Hyperviser Tuning Guide - Joe Topjian'''
All data from the past etherpads have been compiled onto the wiki (https://wiki.openstack.org/wiki/Documentation/HypervisorTuningGuide). My goal right now is to translate the raw notes into something more readable. Once the page starts to resemble a readable guide, I'll try to rally others to join in.

== Doc team meeting ==

We held the APAC docs meeting this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-11-11

Next meetings:
US: Wednesday 18 November, 14:00 UTC
APAC: Wednesday 25 November, 00:30:00 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting


Keep on doc'ing!
Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBCAAGBQJWRWXhAAoJELppzVb4+KUyE5IH/AjYER1GXxR7IE0zz8uIsfqx
rkgm7tJDz5uPZaJr5taXJFtZRiYomZKrZNQ+ijDSt770lUApunr5Q/gkQLrnIyBr
GVZPmsmv8duj6vYYDgIlDNwfaE7BtsCE5Cqvcg+rE8+MpWwFp66I8/AcJ2g0Ez2I
qQZ/mfsWfURAU2rZssBSh4sSl+t90C2TBRYPA2kH45zfyBXKxqXH5q1uFE9XFUwS
BgiUUpFewnAZM+r+dR/efyN/brLUfmI0UkczrazAngq1HsytXBEhxgI7/LJ/xC29
ZA5R11eppGyS3y/6dUvBFVlVLrDm324DPNJD4ykU7eCRJbCUsd4rekD/08UXCeo=
=K6gD
-----END PGP SIGNATURE-----


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

[openstack-dev] What's Up, Doc? 20 Nov 2015

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Hi everyone,

This week I've been working on catching up with some reviews and bug triage, I've been speaking to O'Reilly about the future of the Ops Guide, and also been working on a range of other things including docs-specs core team review, and the addition of Zaqar docs into the user guides.

Just a quick heads up that there won't be a docs newsletter next week, though, as I'm taking a couple of days off (my Mum is coming to visit!), so I'll see you again around 4 December. For those of you in the United States, I hope you all have a lovely Thanksgiving :)

== Progress towards Mitaka ==

138 days to go!

119 bugs closed so far for this release.

RST Conversions
* Arch Guide
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-rst
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
* Ops Guide
** https://blueprints.launchpad.net/openstack-manuals/+spec/ops-guide-rst
** Determining whether or not we want to do an updated version for O'Reilly in L
* Config Ref
** Contact the Config Ref Speciality team: https://wiki.openstack.org/wiki/Documentation/ConfigRef
* Virtual Machine Image Guide
** https://blueprints.launchpad.net/openstack-manuals/+spec/image-guide-rst and https://review.openstack.org/#/c/244598/

Reorganisations
* Arch Guide
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
** Doc sprint in planning for December. Contact the Ops Guide speciality team for more info or to get involved.
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
* User Guides
** https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised
** Contact the User Guide Speciality team: https://wiki.openstack.org/wiki/User_Guides

DocImpact
* I've added some examples to the spec, and we're pretty much ready to go now: https://blueprints.launchpad.net/openstack-manuals/+spec/review-docimpact

Document openstack-doc-tools and reorganise index page
* Thanks to Brian and Christian for volunteering to take this on!

Horizon UX work
* Thanks to the people who offered to help out on this! If you're interested but haven't gotten in touch yet, contact Piet Kruithof of the UX team.

== Speciality Teams ==

'''HA Guide - Bogdan Dobrelya'''
Two patches look ready for merge now: https://review.openstack.org/#/c/225418/ and https://review.openstack.org/235893

'''Installation Guide - Christian Berendt'''
Business as usual. Nothing special to mention this week.

'''Networking Guide - Edgar Magana'''
Open Reviews: https://review.openstack.org/#/c/239361/ Merged: https://review.openstack.org/#/c/246671/ Very slow progress, hoping to speed up after the USA holidays.

'''Security Guide - Nathaniel Dillon'''
No update this week

'''User Guides - Joseph Robinson'''
After a specification update, there is a need to provide a more comprehensive scope: a list of Core features within scope, and include research on the nova-network/ neutron migration study. Contact from Zaqar, Trove, and Murano Liaisons on Admin guide tasks has been helpful, and given the reorganisation direction. A patch on fernet tokens (FAQ format) merged into the Cloud Admin Guide this week.

'''Ops and Arch Guides - Darren Chan'''
Arch guide migration is close to completion. We are currently planning to reorganize the guide over a two day virtual sprint in mid December.

'''API Docs - Anne Gentle'''
Review ready for the Mitaka specification of a vision for app dev docs: https://review.openstack.org/#/c/246660/

'''Config Ref - Gauvain Pocentek'''
The tools are ready, the liberty branch is set up, the RST migration is on! Pick your file, run the tools, and let's review.

'''Training labs - Pranav Salunke'''
Training-labs has Kilo patch merged! We are currently updating the network configuration and trying to get things as per Matt's feedback/request. We plan to start adding Liberty very soon and also KVM port is on the way.

'''Training Guides - Matjaz Pancur'''
There is interest in translating Upstream training; we are waiting for https://review.openstack.org/#/c/245615/ to merge to enable it on the repo.

'''Hyperviser Tuning Guide - Joe Topjian'''
On schedule - working on changing bullet-point notes into rough draft sections.

== Doc team meeting ==

We held the US docs meeting this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-11-18

Next meetings:
APAC: Wednesday 25 November, 00:30:00 UTC
US: Wednesday 2 December, 14:00 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting


Keep on doc'ing!
Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBCAAGBQJWTqBrAAoJELppzVb4+KUyx0kH/0Zk69QewluUYENoLO9Te7ML
RANYc3WVMPVeBzyga2f6W3S2xrboHPJ/Ik1wR1MZaUq+aUmmqTEIM+UAGG4cShdU
H98XzPetsEHgDcseJhU/53Q8XHGAni1uRFv86faaX0uVRgecXK/y2Jjw19Hqg6RB
zOL8oOygM98yFHVdhJ8JKlcgCaKV3FCdDTsE2ZnccHdybPoBc1Wh99aFzzLGr52T
Ekz6cC158a72ednLd7ZcL0p2Tpz9zFbvATV6IzFUx6WExCvfp6qE5Tetd3u+8gXp
0qNsPK2DRMBbUvJncIrr7bhw8sE16EoC6qOY15hDvNiAEHA4nYRZoGy2ZhYx7Qk=
=8w1i
-----END PGP SIGNATURE-----


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

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Hi everyone,

This week I've been working on catching up with some reviews and bug triage, I've been speaking to O'Reilly about the future of the Ops Guide, and also been working on a range of other things including docs-specs core team review, and the addition of Zaqar docs into the user guides.

Just a quick heads up that there won't be a docs newsletter next week, though, as I'm taking a couple of days off (my Mum is coming to visit!), so I'll see you again around 4 December. For those of you in the United States, I hope you all have a lovely Thanksgiving :)

== Progress towards Mitaka ==

138 days to go!

119 bugs closed so far for this release.

RST Conversions
* Arch Guide
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-rst
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
* Ops Guide
** https://blueprints.launchpad.net/openstack-manuals/+spec/ops-guide-rst
** Determining whether or not we want to do an updated version for O'Reilly in L
* Config Ref
** Contact the Config Ref Speciality team: https://wiki.openstack.org/wiki/Documentation/ConfigRef
* Virtual Machine Image Guide
** https://blueprints.launchpad.net/openstack-manuals/+spec/image-guide-rst and https://review.openstack.org/#/c/244598/

Reorganisations
* Arch Guide
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
** Doc sprint in planning for December. Contact the Ops Guide speciality team for more info or to get involved.
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
* User Guides
** https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised
** Contact the User Guide Speciality team: https://wiki.openstack.org/wiki/User_Guides

DocImpact
* I've added some examples to the spec, and we're pretty much ready to go now: https://blueprints.launchpad.net/openstack-manuals/+spec/review-docimpact

Document openstack-doc-tools and reorganise index page
* Thanks to Brian and Christian for volunteering to take this on!

Horizon UX work
* Thanks to the people who offered to help out on this! If you're interested but haven't gotten in touch yet, contact Piet Kruithof of the UX team.

== Speciality Teams ==

'''HA Guide - Bogdan Dobrelya'''
Two patches look ready for merge now: https://review.openstack.org/#/c/225418/ and https://review.openstack.org/235893

'''Installation Guide - Christian Berendt'''
Business as usual. Nothing special to mention this week.

'''Networking Guide - Edgar Magana'''
Open Reviews: https://review.openstack.org/#/c/239361/ Merged: https://review.openstack.org/#/c/246671/ Very slow progress, hoping to speed up after the USA holidays.

'''Security Guide - Nathaniel Dillon'''
No update this week

'''User Guides - Joseph Robinson'''
After a specification update, there is a need to provide a more comprehensive scope: a list of Core features within scope, and include research on the nova-network/ neutron migration study. Contact from Zaqar, Trove, and Murano Liaisons on Admin guide tasks has been helpful, and given the reorganisation direction. A patch on fernet tokens (FAQ format) merged into the Cloud Admin Guide this week.

'''Ops and Arch Guides - Darren Chan'''
Arch guide migration is close to completion. We are currently planning to reorganize the guide over a two day virtual sprint in mid December.

'''API Docs - Anne Gentle'''
Review ready for the Mitaka specification of a vision for app dev docs: https://review.openstack.org/#/c/246660/

'''Config Ref - Gauvain Pocentek'''
The tools are ready, the liberty branch is set up, the RST migration is on! Pick your file, run the tools, and let's review.

'''Training labs - Pranav Salunke'''
Training-labs has Kilo patch merged! We are currently updating the network configuration and trying to get things as per Matt's feedback/request. We plan to start adding Liberty very soon and also KVM port is on the way.

'''Training Guides - Matjaz Pancur'''
There is interest in translating Upstream training; we are waiting for https://review.openstack.org/#/c/245615/ to merge to enable it on the repo.

'''Hyperviser Tuning Guide - Joe Topjian'''
On schedule - working on changing bullet-point notes into rough draft sections.

== Doc team meeting ==

We held the US docs meeting this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-11-18

Next meetings:
APAC: Wednesday 25 November, 00:30:00 UTC
US: Wednesday 2 December, 14:00 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting


Keep on doc'ing!
Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBCAAGBQJWTqEMAAoJELppzVb4+KUyx8AH/0AOs2kfvR8TwvMTO9FSuT2F
UkfrQfzqPIPjU0d4prIkFxJJ3k9NlGDS4+h2lgZSsqYSDRfinoYMkzAOFGOBB0I/
P9KYx7dd+IRagmF2bOfIDBhl+qTxD4GrzaKdzpH9kAaizmf1xylk6VCXT2Yh0PRd
wPRw7RAXg3XjvJhQIElm0pNoRijikAR1CfafzR+HnZMswXPI1S1NnwQSBJD3yYwK
npdfEiICdIkzTcdNMODzN57PXkLBymb++EAW/UsWEnmlyyIGJTZqlJNbd8TAGjHz
vpvILlZHsuJ8mavPASStZy0ZZad3svusNf6pbsZEdUcS3ibZKRSb3xpEOh31eC0=
=7tXE
-----END PGP SIGNATURE-----


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

Re: [Openstack-operators] [OpenStack-docs] [networking-guide] IRC Meeting

Thanks Lana!

Indeed contributors of OpenStack! Join us and provide your input.
Now, including the Ops ML.

Edgar

On 11/29/15, 5:40 PM, "Lana Brindley" openstack@lanabrindley.com wrote:

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Forwarding to the mailing list to increase exposure.

If you are interested in attending the networking guide meetings, please have your say on the meeting times.

Thanks,
Lana

Begin forwarded message:

From: "Edgar Magaña Perdomo" <emagana@gmail.comemagana@gmail.com>
Date: 30 November 2015 at 10:31:12 AM AEST

Team,

You may noticed that I added a patch to include an IRC meeting focus on the networking guide:
https://review.openstack.org/#/c/251169/

I am proposing:
Bi-weekly on Friday 1600 UTC

Please, include your comments and also please confirm your commitment.

Thanks,


Edgar

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBCAAGBQJWW6kBAAoJELppzVb4+KUy8ysH/1mjX5gqVKsJoML1S4LMp2S6
lrXeq/ciUEDQN+F1O7tcTRWUIxMzw7MUGlW4KkfjXcbPT9LNqpeuTnXYzMQwpJOF
eYXGZvLrqO4Jw0vPX6JpDO5lmMGtv1iyXYDUoBNZvb8aV0dUj+ANGefI9LputtR6
iDuSuEpWBv/MPZrH02grdomosYEqbwfHmQGDCsH1lS3fGYcMXub5DwQqkb2vMklQ
w8cugXr0JCrTeFylZl6rnuUQAFP4WX1MBVXr96AtngrFN1POnqsHf6RO53v4YPJx
oqmka9uKv1o8ocuJvFhkhjzoDDYlCfKkips0f6od1EraZrSaFy88sex+j2thxWw=
=hObr
-----END PGP SIGNATURE-----


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

OpenStack-operators mailing list
OpenStack-operators@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators

I think 16 UTC works well for most of the US, but doesn't include APAC and
probably not ideal for EU because it bumps into Friday evening. How about
alternating US/EU and APAC meetings every other week (similar to other
documentation meetings) and move the US/EU meeting to another day?

On Sun, Nov 29, 2015 at 6:44 PM, Edgar Magana edgar.magana@workday.com
wrote:

Thanks Lana!

Indeed contributors of OpenStack! Join us and provide your input.
Now, including the Ops ML.

Edgar

On 11/29/15, 5:40 PM, "Lana Brindley" openstack@lanabrindley.com wrote:

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Forwarding to the mailing list to increase exposure.

If you are interested in attending the networking guide meetings, please
have your say on the meeting times.

Thanks,
Lana

Begin forwarded message:

From: "Edgar Magaña Perdomo" <emagana@gmail.com<mailto:emagana@gmail.com
>
Date: 30 November 2015 at 10:31:12 AM AEST

Team,

You may noticed that I added a patch to include an IRC meeting focus on
the networking guide:
https://review.openstack.org/#/c/251169/

I am proposing:
Bi-weekly on Friday 1600 UTC

Please, include your comments and also please confirm your commitment.

Thanks,


Edgar

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBCAAGBQJWW6kBAAoJELppzVb4+KUy8ysH/1mjX5gqVKsJoML1S4LMp2S6
lrXeq/ciUEDQN+F1O7tcTRWUIxMzw7MUGlW4KkfjXcbPT9LNqpeuTnXYzMQwpJOF
eYXGZvLrqO4Jw0vPX6JpDO5lmMGtv1iyXYDUoBNZvb8aV0dUj+ANGefI9LputtR6
iDuSuEpWBv/MPZrH02grdomosYEqbwfHmQGDCsH1lS3fGYcMXub5DwQqkb2vMklQ
w8cugXr0JCrTeFylZl6rnuUQAFP4WX1MBVXr96AtngrFN1POnqsHf6RO53v4YPJx
oqmka9uKv1o8ocuJvFhkhjzoDDYlCfKkips0f6od1EraZrSaFy88sex+j2thxWw=
=hObr
-----END PGP SIGNATURE-----


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-operators mailing list
OpenStack-operators@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators

[openstack-dev] What's Up, Doc? 4 December 2015

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Hi everyone,

Slight delay in the newsletter this time around, it's been a busy week! I've been working on the DocImpact changes, reviewing the docs and docs-specs core teams, and catching up with blueprint management and reviews from while I was on leave.

Since we're getting to the pointy end of the year, remember to call out successes using #success in our IRC channel. All successes get logged here: https://wiki.openstack.org/wiki/Successes and it's a great way to show your appreciation for your fellow community members.

== Progress towards Mitaka ==

121 days to go!

139 bugs closed so far for this release.

RST Conversions
* Arch Guide
** RST conversion is complete! Well done Shilla and team for getting this done so incredibly quickly :)
* Config Ref
** Contact the Config Ref Speciality team: https://wiki.openstack.org/wiki/Documentation/ConfigRef
* Virtual Machine Image Guide
** https://blueprints.launchpad.net/openstack-manuals/+spec/image-guide-rst and https://review.openstack.org/#/c/244598/

Reorganisations
* Arch Guide
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
** Doc sprint in planning for December 21-22. Contact the Ops Guide speciality team for more info or to get involved.
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
* User Guides
** https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised
** Contact the User Guide Speciality team: https://wiki.openstack.org/wiki/User_Guides

DocImpact
* This is now well underway, with the first two patches merged. One changes the default bug queue for DocImpact back to the projects' own queue, and the other changes all current projects (with the exception of the six defcore projects) to their own bug queue. There has also been some discussion on the mailing lists about this process change. The next step is to merge the new Jenkins job (https://review.openstack.org/#/c/251301/) which for now will be against Nova only so we can make sure it's working correctly before we roll it out across the board. Thank you to Andreas, Josh Hesketh, and everyone else who has helped get us this far, and to the Nova team who are allowing us to use them as guinea pigs.

Document openstack-doc-tools and reorganise index page
* Thanks to Brian and Christian for volunteering to take this on!

Horizon UX work
* Thanks to the people who offered to help out on this! If you're interested but haven't gotten in touch yet, contact Piet Kruithof of the UX team. There is now a blueprint + spec in draft: https://blueprints.launchpad.net/openstack-manuals/+spec/ui-content-guidelines and https://review.openstack.org/#/c/252668/

== Speciality Teams ==

'''HA Guide - Bogdan Dobrelya'''
Finished IRC meeting schedule poll, finalised the Corosync/pacemaker patch (https://review.openstack.org/235893), participating and tracking progress with the HA for OpenStack instances research (https://etherpad.openstack.org/p/automatic-evacuation) to make it into the HA guide, eventually.

'''Installation Guide - Christian Berendt'''
Debian install guide nearly completed, testers needed; meeting time for the EU/US meeting will probably change from 13 UTC to 17 UTC; Aodh install instructions nearly finished, ongoing discussion because of missing SUSE packages; Japanese translation of the Liberty install guide published.

'''Networking Guide - Edgar Magana'''
We are having our first official IRC meeting tomorrow at 1600 UTC. The goal is to find out what we can to complete during the Liberty cycle and have specific tasks assigned. Relevant patches: Create tags for the Networking Guide - WIP (https://review.openstack.org/#/c/251979/)

'''Security Guide - Nathaniel Dillon'''
No update this week

'''User Guides - Joseph Robinson'''
The User guide meeting on IRC worked, however attendance was down; the reorganization spec is updated with information from Big Tent Project navigator to define the scope (http://www.openstack.org/software/project-navigator) and information from the published nova-network to neutron migration study.

'''Ops and Arch Guides - Darren Chan'''
The arch guide RST conversion is completed. We plan on doing a virtual swarm this December. The doodle link was sent out last week and the poll is now closed. The final date for the virtual swarm is: 12/21-12/22.

'''API Docs - Anne Gentle'''
Working on usage docs for migration, how to build, what gets migrated, how the docs are assembled: https://github.com/russell/fairy-slipper/blob/master/doc/source/usage.rst Responding to spec reviews: https://review.openstack.org/#/c/246660/ Revising patch to bring fairy-slipper into openstack org: https://review.openstack.org/#/c/245352/

'''Config Ref - Gauvain Pocentek'''
The RST migration is still in progress. The Manila section has been greatly improved in the process, and the Zaqar documentation should land during this cycle as the spec has been approved.

'''Training labs - Pranav Salunke'''
KVM port is almost done. Planned to merge this by end of this week; Network configuration for the cluster is updated. Now it uses same network addresses as install guides; Welcome berndbausch into our team; Liberty port is in progress. Follow https://etherpad.openstack.org/p/training-labs-liberty for more details; Need to decide meeting time for weekly IRC meetings.

'''Training Guides - Matjaz Pancur'''
No update this week

'''Hyperviser Tuning Guide - Joe Topjian'''
Still on schedule. Halfway done with a first-pass cleanup. Should be ready for open contributions within 2 weeks.

== Core Team Changes ==

During last week, I announced some changes to the docs-specs core team. Previously, this core team was a small subset of docs core team members, with an understanding that we would wait for speciality team leads to +1 a spec relevant to their team before approving. Now we have formalised that process by inviting each speciality team lead to the docs-specs core team, so that they can +2A their own specs. Speciality team leads are listed on the wiki here: https://wiki.openstack.org/wiki/Documentation/SpecialityTeams remember to engage them when you create a new spec for approval.

We have also reviewed the current docs core team list for December, and the results of that will be announced shortly. We will not be reviewing the team in January because of the holiday period, and will resume regular reviews in February 2016.

== Doc team meeting ==

We held the APAC docs meeting this week. Big thanks to Joseph for running that while I was away, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-11-25

Next meetings:
US: Wednesday 9 December, 14:00 UTC
APAC: Wednesday 16 December, 00:30:00 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting


Just a note that this will be my penultimate newsletter for 2015.

Keep on doc'ing!
Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBCAAGBQJWZPzNAAoJELppzVb4+KUyT+IH/0yFFN5+X1WG5mbq+SUK0DnP
av+pdcVbIlVpSuVgI5rV69ri3TwnU9DmFyJfOcx7h3ZRib3ri3T09UQ7L4A/EvfL
Ar+AzG0OLriSLz1WJEVhg8VYkVuxVugIfAUvrKyNPIQs9sbDHQfmnpYoyZ8LB/TK
tXd6+R15yMt+2KOPfKT2UMj8NUhf+XYxEpuW8TCTNss3GWlQZBHy9USNFfat+rzY
MaLpUGGG6dviKgWGStGOD4I2JUIswobqFRdOKJ0a3h7vDEPeJMkr+OHDG3wzNMx7
n2TL5jAf2teIoys0sLP7qVRBD/c4cQHIGi0C70iWlqSrbG80yq27Prc0cJrl/VA=
=rNRL
-----END PGP SIGNATURE-----


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

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

So it turns out calendars are hard, and I screwed up the meeting times in my last newsletter. Corrected dates are below:

On 07/12/15 13:28, Lana Brindley wrote:

== Doc team meeting ==

We held the APAC docs meeting this week. Big thanks to Joseph for running that while I was away, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2015-11-25

Next meetings:

APAC: Wednesday 9 December, 00:30:00 UTC (CANCELLED)
US: Wednesday 16 December, 14:00 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

Sorry for the confusion. I blame impending holidays and all that online shopping I've been doing ;)

L


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBCAAGBQJWZ3c0AAoJELppzVb4+KUy/dIH/2rpR7GoWsYxKZ7eVO2U14Xc
MoLTYRKnYBHURm9r3Af/TVhOPR9gDYA8VbAfPgegOsaKZ2xkORqj8/vaa7KTw5rF
yZUMDe3jD/HajMkDSCbjnTd445oPmb/5G1lCwXQipQO/6wDGTv3QnJd3hhL+RxMz
2Z9Sdj6yTBlT1/cMozjgR/BpQUbblNIS3Qr+xccv/BMw3OlV4j7zpMguA0mePfhN
lXpCIBRoKfhy/LPBd5Na8xdgdpiicLqLiWb+OCwXlIiB3QA50jJlwGlxQ/1RxxGr
VQBCMp+poL3pja15W7l8leejo/DrTGNFle6IMuTRI+7+yqG2Kma83xMIfxQbKEk=
=wu0f
-----END PGP SIGNATURE-----


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

[openstack-dev] What's Up, Doc? Holiday Edition

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Hi everyone,

This is my final newsletter for the year, as I'm taking summer vacation over the next few weeks (yay for Southern Hemisphere weather!). Your regularly scheduled programming will resume in mid-January.

I would like to take a moment to acknowledge the incredible work of the entire documentation team, especially the core team who have worked all year to keep on top of reviews, the speciality team leads who motivate and inspire their teams each and every day, and every single documentation contributor and reviewer: without you all doing your little bit, we wouldn't have had the success we have had. Thank you also to our crew of support people: from infra and release management, to our subject matter experts and the wonderful people on the TC and at Foundation. Thanks for helping us be the best we can be. I would also like to make special mention of Andreas Jaeger and Anne Gentle, who both continue to hold my hand daily and make sure I don't make too much of a fool of myself in public. Your support and encouragement have been invaluable.

While we're on the goodwill wagon: if there's someone (or something!) you would like to call out for a special mention, you can do so using #success in our IRC channel. All successes get logged here: https://wiki.openstack.org/wiki/Successes and it's a great way to show your appreciation for your fellow community members.

== Progress towards Mitaka ==

117 days to go!

150 bugs closed so far for this release.

RST Conversions
* Arch Guide
** RST conversion is complete! Well done Shilla and team for getting this done so incredibly quickly :)
* Config Ref
** Is underway: contact the Config Ref Speciality team: https://wiki.openstack.org/wiki/Documentation/ConfigRef
* Virtual Machine Image Guide
** Is complete! Well done Tomoyuki-san :)

Reorganisations
* Arch Guide
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
** Doc sprint planned for December 21-22. Contact the Ops Guide speciality team for more info or to get involved.
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
* User Guides
** https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised
** Contact the User Guide Speciality team: https://wiki.openstack.org/wiki/User_Guides

DocImpact
* Waiting to merge the patch for the new Jenkins job: https://review.openstack.org/#/c/251301/ which for now will be against Nova only so we can make sure it's working correctly before we roll it out across the board.

Document openstack-doc-tools and reorganise index page
* Thanks to Brian and Christian for volunteering to take this on!

Horizon UX work
* Thanks to the people who offered to help out on this! If you're interested but haven't gotten in touch yet, contact Piet Kruithof of the UX team. There is now a blueprint + spec in draft: https://blueprints.launchpad.net/openstack-manuals/+spec/ui-content-guidelines and https://review.openstack.org/#/c/252668/

== Speciality Teams ==

'''HA Guide - Bogdan Dobrelya'''
The change to shift IRC meeting was not accepted. Going to create a new poll this time with correct options suggested by Tony Breeds. No more updates.

'''Installation Guide - Christian Berendt'''
We require Debian Install Guide testers. Please contact Christian if you're interested.

'''Networking Guide - Edgar Magana'''
The networking guide had its first official IRC meeting: https://wiki.openstack.org/wiki/Documentation/NetworkingGuideMeetings We are restructuring a little bit the wikis for better engagement with new contributors; Versioning spec for networking guide has been merged: https://review.openstack.org/#/c/253283/ Working of the remaining actions items from the meeting: http://eavesdrop.openstack.org/meetings/networking_guide/2015/networking_guide.2015-12-03-16.00.txt We have proposed a time and date for an IRC meeting covering APAC time zone: https://review.openstack.org/#/c/254999/

'''Security Guide - Nathaniel Dillon'''
Planning for a bug sprint and general triage/cleanup.

'''User Guides - Joseph Robinson'''
The User Guide Reorganization Spec merged this week, and the final User Guide meeting for 2016 has been rescheduled to next Thursday December 16 at 23:30 UTC, and the plan is to discuss work items. A patch for the User Guide Dashboard has begun using the blueprint implementation as a start to the reorg.

'''Ops and Arch Guides - Shilla Saebi'''
Regarding this spec - https://review.openstack.org/#/c/227660/, we decided we are going to hold off until the N-release; Architecture Guide Swarm - Asking for everyone who wants to help to please use the https://etherpad.openstack.org/p/arch-guide-reorg to document potential changes; The arch guide RST conversion is complete; For the swarm, everyone works in their timezone. They will then submit patches and allocate team members in the other timezones to review; The final dates for the arch guide virtual swarm is: 12/21-12/22.

'''API Docs - Anne Gentle'''
Trimming down what is output so that eventually we'll get working Swagger migrated from WADL. Repo still awaits being pulled into gerrit: https://github.com/russell/fairy-slipper to
https://review.openstack.org/#/c/245352/ Nova API docs sprint 12/8 and 12/9 came up with good questions and answers and patches. Also, the Gabbi API test suite has a new release, see http://lists.openstack.org/pipermail/openstack-dev/2015-December/081891.html

'''Config Ref - Gauvain Pocentek'''
The configuration reference RST migration is almost done, only a few more Block Storage drivers docs to handle. Thanks to all the contributors!

'''Training labs - Roger Luethi'''
Training-labs merged a KVM provider patch which allows the training cluster to build on top of KVM. The IP address ranges now match the install guides. The Liberty training cluster is being worked on.

'''Training Guides - Matjaz Pancur'''
Through no fault of Matjaz', this report was erroneously left out of the last newsletter, sorry for the delay:
A complete Korean translation of the Upstream training material is officially published at http://docs.openstack.org/ko_KR/upstream-training/ (big thanks to Ian Y. Choi and KATO Tomoyuki)

'''Hyperviser Tuning Guide - Joe Topjian'''
Finished the first pass of converting etherpad notes to the wiki. I sent an email http://lists.openstack.org/pipermail/openstack-operators/2015-December/009147.html to the openstack-operators with a summary of the current state. Hopefully the guide will pick up two or three regular contributors to help things along. I'll continue to work on it 1-2 hours a week as I get time.

== Core Team Changes ==

I would like to offer a warm welcome to Atsushi Sakai as our newest core team member. Welcome to the team :)

We will resume regular reviews in February 2016.

== Doc team meeting ==

We failed to hold the APAC docs meeting this week because I can't read a calendar, and clearly just need a holiday. My apologies!

Next meetings:
US: Wednesday 16 December, 14:00 UTC
APAC: Will resume in the new year

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting


Happy holidays everyone, and remember to ...

Keep on doc'ing!

Lana


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBCAAGBQJWaj4RAAoJELppzVb4+KUyFoAH/jVqenzze6Pl6xF68dKBwouT
ij8j80wBMdbUzyn4zc4726uxQ1TMdzXgK+8Q8Ouk4fOewn6cV9rOZJelpSPSboOR
Lv4mjm172UxqnrN1npy5f9tB9EnIC/R8N0KlZHJmD0YJ/EbiJ0Hv/wl4/6+f8L7D
Ns6iIUylI62a/ycIs7Wz5RGASaMZpZaP1XEeQtUoXbpIHggTlxPcHgETayHVnBMl
5qIuG5B5fgIOdUKQAa41SuMRCttxyHStXCFM/lborpDd6vEbMR2S/UbJb+7zh0jK
PIACfhsnnZCBiZqno9NFnxBehdqTXpDG3crG0I9Ajd2YnEdhmFro+jMQr56lkGE=
=1Kk+
-----END PGP SIGNATURE-----


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

[openstack-dev] [networking guide meeting] Meeting Tomorrow!

Hello All,

Friendly reminder email that we have our networking guide team meeting tomorrow Thursday at 16:00 UTC in #openstack-meeting

Agenda:

https://wiki.openstack.org/wiki/Documentation/NetworkingGuide/Meetings

Thanks,

Edgar


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

Hi,

Kind reminder email that we have our networking guide team meeting tomorrow Thursday at 16:00 UTC in #openstack-meeting

Cheers,

Edgar


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

[Openstack-operators] OpenStack Architecture Design Guide Virtual Swarm

All,

We are set and ready to go for the architecture design guide virtual swarm
on 12/21 and 12/22. This will be our first combined effort to rework the
guide, starting with the virtual two day swarm. At this time, we are still
looking for SMEs to review the current guide, the proposed structure and
suggest changes to the information architecture and content. Sign up to
volunteer at the following link:

https://etherpad.openstack.org/p/arch-guide-reorg

The virtual swarm is scheduled for the 21st and 22nd of December and it's
flexible for everyone to work in their own time zone. We have designated a
freenode IRC channel for the swarm: #arch-guide-swarm

Feel free to join and sign up, look forward to seeing you there!

Shilla


OpenStack-operators mailing list
OpenStack-operators@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators

[openstack-dev] [doc] [api] Vision and changes for OpenStack API Guides

Hi all,

With milestone 2 coming next week I want to have a chat about API guides,
API reference information, and the http://developer.openstack.org site. We
have a new tool, fairy-slipper [1], yep you read that right, that can
migrate files from WADL to Swagger as well as serve up reference info. We
also have new build jobs that can build API guides right from your projects
repo to developer.openstack.org.

There's a lot going on, so I've got an agenda item for next week to hold a
cross-project meeting so that you can send a team representative to get the
scoop on API guides and bring it back to your teams. I've fielded great
questions from a few teams, and want to ensure everyone's in the loop.

A pair of specs set the stage for this work, feel free to review these in
advance of the meeting and come with questions. [2] [3]

Join me next week at the first pop-up Cross Project meeting, Tuesday at
1700, in #openstack-meeting-cp. Feel free to add to the agenda at

Thanks,
Anne

  1. https://github.com/openstack/fairy-slipper
  2. mitaka spec:
    http://specs.openstack.org/openstack/docs-specs/specs/mitaka/app-guides-mitaka-vision.html
  3. liberty spec:
    http://specs.openstack.org/openstack/docs-specs/specs/liberty/api-site.html

--
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com


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

On Fri, Jan 8, 2016 at 3:39 PM, Anne Gentle annegentle@justwriteclick.com
wrote:

Hi all,

With milestone 2 coming next week I want to have a chat about API guides,
API reference information, and the http://developer.openstack.org site.
We have a new tool, fairy-slipper [1], yep you read that right, that can
migrate files from WADL to Swagger as well as serve up reference info. We
also have new build jobs that can build API guides right from your projects
repo to developer.openstack.org.

There's a lot going on, so I've got an agenda item for next week to hold a
cross-project meeting so that you can send a team representative to get the
scoop on API guides and bring it back to your teams. I've fielded great
questions from a few teams, and want to ensure everyone's in the loop.

A pair of specs set the stage for this work, feel free to review these in
advance of the meeting and come with questions. [2] [3]

Join me next week at the first pop-up Cross Project meeting, Tuesday at
1700, in #openstack-meeting-cp. Feel free to add to the agenda at

Woops, agenda here:

https://wiki.openstack.org/wiki/Meetings/CrossProjectMeeting#Proposed_agenda

Thanks,
Anne

  1. https://github.com/openstack/fairy-slipper
  2. mitaka spec:
    http://specs.openstack.org/openstack/docs-specs/specs/mitaka/app-guides-mitaka-vision.html
  3. liberty spec:
    http://specs.openstack.org/openstack/docs-specs/specs/liberty/api-site.html

--
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com

--
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com


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

[openstack-dev] App dev guides update [nova] [keystone] [cinder] [swift] [glance] [neutron] [trove] [heat] [manila] [ceilometer] [sahara] [senlin]

Hi all,
I wanted to be sure to post to the dev, docs, and user mailing lists about
the progress towards supporting application devs using OpenStack REST APIs.
We discussed at the cross-project meeting today and you can read more
details in the meeting log. [1]

This blog post [2] explains what's happening this month with a migration as
well as build jobs that enable project teams to write tutorials and how-to
guides.

This Thursday afternoon/ early Friday morning, the new fairy-slipper core
team [3] is meeting in Google Hangout to get to put faces to names. Feel
free to join us if you're interested!

I'll be reaching out to the API working group liaisons [4] to be sure you
all are up-to-date and can take any next actions you need to. You're always
welcome to attend the doc team meeting which has a standing item about API
doc and design.

Thanks to everyone who got us this far -- Russell Sim and Karen Bradshaw
especially! Also, thanks to the API working group and the nova API
specialty team for poking at the early work and being willing to carry the
torch. And of course, Diane Fleming's work accounts for over 60% of all
patches for the http://developer.openstack.org site, her volume and quality
of work is wonderful. Thanks to Tom Fifield for connecting the dots and the
peeps.

I also want to emphasize that over 120 individual contributors kept the API
reference info updated in the last release, and that long tail of
contributions is what's keeping this valuable info accurate and trusted.
Thanks to every one of you.
Anne

1.
http://eavesdrop.openstack.org/meetings/crossproject/2016/crossproject.2016-01-12-21.02.log.html
2.
http://www.openstack.org/blog/2016/01/whats-next-for-application-developer-guides/
.
3. https://review.openstack.org/#/admin/groups/1240,members
4. http://specs.openstack.org/openstack/api-wg/liaisons.html

The full blog post is pasted below, for those who don't like to
clickety-click-click too much. :)
What's new for application developer guides?
Summary
This month, the developer.openstack.org site gets a new look and changes
its source tooling. Read on for details about how these changes affect your
project team.

Why are we changing the developer.openstack.org site?
You might know that the developer.openstack.org site documents over
900GET/PUT/POST/DELETE/PATCH calls for a dozen OpenStack services already
on the developer.openstack.org site. As a couple of the keynote speakers in
Tokyo so elegantly put it, the trustworthiness and consistency of the
OpenStack APIs influenced their decision to run their business workloads in
an OpenStack cloud.

Those interfaces need docs, lots of docs, and not only reference docs.
While it takes a huge effort to maintain accurate references, we also need
to document API usage and scenarios.

Now that we’ve written both an API Guide and a “Writing your first
OpenStack application” tutorial, we want the site to be the go-to location
for app devs, product developers, and anyone who needs to unlock the power
of their OpenStack infrastructure.

In this release, the docs’ platform introduces tooling that lets you
migrate from WADL to Swagger and integrate RST-sourced documentation with
the API reference documentation. The “why” analysis is clear: we must
community-source this info and make it easy to maintain and update so that
users can trust it enough to bet their workloads on it.

Later on, this post answers the “how” questions.

Why all these changes at this point in the release?
Well, we haven’t had to release the API documentation like we release
services documentation. We have done a lot of maintenance on the site, with
bug fixing and so on. But it’s time to take the leap. Last release we made
a proof-of-concept. This release we unleash a solution that helps us make
incremental progress toward our goals.

How do you keep your API docs updated after January 16th?
On January 16th, we’ll migrate the Images API WADL and DocBook files to
Swagger and RST files. Then we’ll test the build process and the content
itself to validate the migration.

After testing, we will migrate the files for these services:

Identity
Compute
Images
Networks
Block Storage
Object Storage

Then, the remaining services can migrate their files by using the validated
tooling.

If you do provide an OpenStack API service, read on.

For the nova project, place your how-to and conceptual articles in the
api-guide folder in the nova repository. Other projects can mimic these
patches that created an api-guide and build jobs for the Compute api-guide.
You continue to update reference information in the openstack/api-site
repo. However, the source files have changed.

With this release, you can embed annotations in your source code if you
want to generate the reference information. Here’s an example patch from
the nova project. Because we haven’t had a project do this yet completely,
the build jobs still need to be written.

If your project already has WADL files, they will be migrated to Swagger
files and stored in the api-site repository. The WADL files will be
deleted; you can retrieve them from Git.

If your project does not have a WADL file, then you write Swagger plus RST
to document your API calls, parameters, and reference information. You can
generate Swagger from annotations or create Swagger from scratch that you
store in the api-site repository. You should review, store, and build RST
for conceptual or how-to information from within your project team’s
repository.

All projects should use this set of API documentation guidelines from the
OpenStack API working group any time their service has a REST API. This
document tells you what and how much to write. If you follow the suggested
outline, your API guide will be accurate and complete.

After the source files and build jobs exist, the docs are built to
developer.openstack.org.

Where can I get help for my project’s API Guides?

These specifications describe the details: Application Developer Guides and
Rework API Reference Information.

You can ask questions in #openstack-sdks or #openstack-docs on IRC. We
await those magical API docs fairies who grant wishes, but in the meantime
but we can point you in the right direction and give you the tools for your
quest.

What if I still have questions?

Contact me, Anne Gentle, by email or IRC and I’ll get back to you as soon
as possible.

I’m eager to enable our audience with great user-centric docs and hope that
you’ll join us as we fulfill the vision.--
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com


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

Anne, thank you for this update. And thank you to the contributors who
improved the SDK and developer guide documentation. Fantastic work, all
of you!

Best,
-jay

On 01/13/2016 12:18 AM, Anne Gentle wrote:
Hi all,
I wanted to be sure to post to the dev, docs, and user mailing lists
about the progress towards supporting application devs using OpenStack
REST APIs. We discussed at the cross-project meeting today and you can
read more details in the meeting log. [1]

This blog post [2] explains what's happening this month with a migration
as well as build jobs that enable project teams to write tutorials and
how-to guides.

This Thursday afternoon/ early Friday morning, the new fairy-slipper
core team [3] is meeting in Google Hangout to get to put faces to names.
Feel free to join us if you're interested!

I'll be reaching out to the API working group liaisons [4] to be sure
you all are up-to-date and can take any next actions you need to. You're
always welcome to attend the doc team meeting which has a standing item
about API doc and design.

Thanks to everyone who got us this far -- Russell Sim and Karen Bradshaw
especially! Also, thanks to the API working group and the nova API
specialty team for poking at the early work and being willing to carry
the torch. And of course, Diane Fleming's work accounts for over 60% of
all patches for the http://developer.openstack.org site, her volume and
quality of work is wonderful. Thanks to Tom Fifield for connecting the
dots and the peeps.

I also want to emphasize that over 120 individual contributors kept the
API reference info updated in the last release, and that long tail of
contributions is what's keeping this valuable info accurate and trusted.
Thanks to every one of you.
Anne

1.
http://eavesdrop.openstack.org/meetings/crossproject/2016/crossproject.2016-01-12-21.02.log.html
2.
http://www.openstack.org/blog/2016/01/whats-next-for-application-developer-guides/.

  1. https://review.openstack.org/#/admin/groups/1240,members
  2. http://specs.openstack.org/openstack/api-wg/liaisons.html

The full blog post is pasted below, for those who don't like to
clickety-click-click too much. :)
What's new for application developer guides?
Summary
This month, the developer.openstack.org
site gets a new look and changes its source tooling. Read on for details
about how these changes affect your project team.

Why are we changing the developer.openstack.org
site?
You might know that the developer.openstack.org
site documents over
900GET/PUT/POST/DELETE/PATCH calls for a dozen OpenStack services
already on the developer.openstack.org
site. As a couple of the keynote speakers in Tokyo so elegantly put it,
the trustworthiness and consistency of the OpenStack APIs influenced
their decision to run their business workloads in an OpenStack cloud.

Those interfaces need docs, lots of docs, and not only reference docs.
While it takes a huge effort to maintain accurate references, we also
need to document API usage and scenarios.

Now that we’ve written both an API Guide and a “Writing your first
OpenStack application” tutorial, we want the site to be the go-to
location for app devs, product developers, and anyone who needs to
unlock the power of their OpenStack infrastructure.

In this release, the docs’ platform introduces tooling that lets you
migrate from WADL to Swagger and integrate RST-sourced documentation
with the API reference documentation. The “why” analysis is clear: we
must community-source this info and make it easy to maintain and update
so that users can trust it enough to bet their workloads on it.

Later on, this post answers the “how” questions.

Why all these changes at this point in the release?
Well, we haven’t had to release the API documentation like we release
services documentation. We have done a lot of maintenance on the site,
with bug fixing and so on. But it’s time to take the leap. Last release
we made a proof-of-concept. This release we unleash a solution that
helps us make incremental progress toward our goals.

How do you keep your API docs updated after January 16th?
On January 16th, we’ll migrate the Images API WADL and DocBook files to
Swagger and RST files. Then we’ll test the build process and the content
itself to validate the migration.

After testing, we will migrate the files for these services:

Identity
Compute
Images
Networks
Block Storage
Object Storage

Then, the remaining services can migrate their files by using the
validated tooling.

If you do provide an OpenStack API service, read on.

For the nova project, place your how-to and conceptual articles in the
api-guide folder in the nova repository. Other projects can mimic these
patches that created an api-guide and build jobs for the Compute
api-guide. You continue to update reference information in the
openstack/api-site repo. However, the source files have changed.

With this release, you can embed annotations in your source code if you
want to generate the reference information. Here’s an example patch from
the nova project. Because we haven’t had a project do this yet
completely, the build jobs still need to be written.

If your project already has WADL files, they will be migrated to Swagger
files and stored in the api-site repository. The WADL files will be
deleted; you can retrieve them from Git.

If your project does not have a WADL file, then you write Swagger plus
RST to document your API calls, parameters, and reference information.
You can generate Swagger from annotations or create Swagger from scratch
that you store in the api-site repository. You should review, store, and
build RST for conceptual or how-to information from within your project
team’s repository.

All projects should use this set of API documentation guidelines from
the OpenStack API working group any time their service has a REST API.
This document tells you what and how much to write. If you follow the
suggested outline, your API guide will be accurate and complete.

After the source files and build jobs exist, the docs are built to
developer.openstack.org .

Where can I get help for my project’s API Guides?

These specifications describe the details: Application Developer Guides
and Rework API Reference Information.

You can ask questions in #openstack-sdks or #openstack-docs on IRC. We
await those magical API docs fairies who grant wishes, but in the
meantime but we can point you in the right direction and give you the
tools for your quest.

What if I still have questions?

Contact me, Anne Gentle, by email or IRC and I’ll get back to you as
soon as possible.

I’m eager to enable our audience with great user-centric docs and hope
that you’ll join us as we fulfill the vision.--
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com


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


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

[openstack-dev] [docs] Specialty teams wiki page moving to Contributor Guide

Good Friday to everyone!

This is just a note that the Specialty Teams wiki page has been moved from
wiki [1] to the Documentation Contributor Guide [2] as of now.

Thanks and happy week-end!

Olena

[1] https://wiki.openstack.org/wiki/Documentation/SpecialityTeams
[2] http://docs.openstack.org/contributor-guide/team-structure.html

--
Best regards,
Olena Logvinova,
Technical Writer | Mirantis, Kharkiv | 38, Lenin av., Kharkiv
ologvinova@mirantis.com


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

[openstack-dev] What's Up Doc? 12 Feb 2016

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Hi everyone,

This week has been all about the Install Guide. We're locating pre-release packages now so we can begin testing in about two weeks' time. Please consider being a tester for this release. Even if you've never done it before, it's a great way to improve your OpenStack knowledge, and the more people we have testing, the better and more accurate our docs will be, which helps everyone. We're also starting to see a little more action in the lead up to the Austin Summit. ATC passes are going out, and the talk sessions are now open for voting: https://www.openstack.org/summit/austin-2016/vote-for-speakers/

== Progress towards Mitaka ==

54 days to go!

389 bugs closed so far for this release.

Docs Testing
* Volunteers required!
* https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting

RST Conversions
* All planned RST conversions are now complete!

Reorganisations
* Arch Guide: really needs a last minute push to get this complete before Mitaka. If you can help out, it would be greatly appreciated!
** https://blueprints.launchpad.net/openstack-manuals/+spec/archguide-mitaka-reorg
** Contact the Ops Guide Speciality team: https://wiki.openstack.org/wiki/Documentation/OpsGuide
* User Guides
** https://blueprints.launchpad.net/openstack-manuals/+spec/user-guides-reorganised
** Contact the User Guide Speciality team: https://wiki.openstack.org/wiki/User_Guides

DocImpact
* Is now complete

== The Road to Austin ==

== Speciality Teams ==

'''HA Guide - Bogdan Dobrelya'''
Minor updates to the corosync/pacemaker, rabbitmq clusters setup guides

'''Installation Guide - Christian Berendt'''
Mitaka Installation guide changes spec: https://review.openstack.org/#/c/274231/ Testing beginning, require packages: https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting

'''Networking Guide - Edgar Magana'''
Move the IRC meeting agenda to etherpad: https://etherpad.openstack.org/p/docnetworkingteam-agenda. Important Commits: DSCP addition to advanced qos guide: https://review.openstack.org/#/c/273638/ Add networking guide to Contributors Section: https://review.openstack.org/#/c/278330/ Last IRC Meeting Notes: http://eavesdrop.openstack.org/meetings/networking_guide/2016/networking_guide.2016-02-04-16.02.log.html

'''Security Guide - Nathaniel Dillon'''
Continuing bugfixes and beginning Networking review (thanks to all Neutron contributors!)

'''User Guides - Joseph Robinson'''
Held First US/EU Meeting, which was 1 and a 1/2 hours before the APAC meeting (Need to reserve the meeting time). Discussed Reorg- High Priority step - moving Dashboard content from the Admin Guide to the Cloud Admin Dashboard Chapter.

'''Ops and Arch Guides - Shilla Saebi'''
Architecture guide reorganization is underway. We have a drafts repo in openstack-manuals, feel free to ping Shilla or Darren Chan if you are interested in helping out. Considering doing a swarm or work session at the summit in Austin for the Arch guide. Operations guide RST migration pending - conversations still happening to see which route we'll take. Still deciding if the ops guide should have another revision or edition, see ML emails.

'''API Docs - Anne Gentle'''
No update this week.

'''Config Ref - Gauvain Pocentek'''
No update this week.

'''Training labs - Pranav Salunke, Roger Luethi'''
We reviewed and merged several patches: bug fixes, refactoring and some code to help with debugging.

'''Training Guides - Matjaz Pancur'''
No update this week.

'''Hypervisor Tuning Guide - Joe Topjian'''
No update this week.

'''UX/UI Docs Guidelines - Linette Williams'''
No update this week.

== Doc team meeting ==

Next meetings:

The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-02-10

Next meetings:
US: Wednesday 17 February, 14:00 UTC
APAC: Wednesday 24 February, 00:30 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

Note that there is currently discussion about moving the US meeting to 20:00 UTC. A patch is open to change this, with ongoing discussion about finding a meeting room: https://review.openstack.org/#/c/271361/


Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#12_February_2016


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBCAAGBQJWvWWOAAoJELppzVb4+KUyadwIAIzWAp7pJChEUmd6joi4GHig
OLuvC3nsD6NnjW4qtK6OHdPklZQ6nN8JgNGhbnbBWhmO6/Pk4ulk4TUl5ENtYPxJ
hCzQ3OKcgrj+Edb08mk7ck0uCXDQCnopDQfphNFVTObRWw6dpEBbWQBiy0zy0rsX
rbp9P+TBOpbPHRgVoI/IvLps/lnlzYQM5QX+kBq0EdG6lG3jU1jDz6Lc3s8onZUV
kim0xvw8Kq+l8ziJaf5UZ62ybKJeg/quhffvblVU0iU20m1sNpK6ockjR5miIJWt
pSFgE1O4/AERn5/8lH72Nzm+2BuLYoxN749luRHU3agoewFxNdvpch0V7IdSv5c=
=gytH
-----END PGP SIGNATURE-----


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

[openstack-dev] [docs] [api] Why WADL when you can Swagger

Hi all,
I wanted to give an update on the efforts to provide improved application
developer information on developer.openstack.org. Wrangling this much
valuable information and gathering it in a way that helps people is no
simple matter. So. We move forward one step at a time.

What's new?


This week, with every build of the api-site, we are now running
fairy-slipper to migrate from WADL to Swagger for API reference
information. Those migrated Swagger files are then copied to
developer.openstack.org/draft/swagger.

We know that not all files migrate smoothly. We'd love to get teams looking
at these migrated files. Thank you to those of you already submitting
fixes!

In addition, the infra team is reviewing a spec now so that we can serve
API reference information from the developer.openstack.org site:
https://review.openstack.org/#/c/276484/

Why are we doing all this?


The overall vision is still intact in the original specifications [1][2],
however we need to do a lot of web design and front end work to get where
we want to be.

What can I do?


Check out these Swagger files.
http://developer.openstack.org/draft/swagger/blockstorage-v1-swagger.json
http://developer.openstack.org/draft/swagger/blockstorage-v2-swagger.json
http://developer.openstack.org/draft/swagger/clustering-v1-swagger.json
http://developer.openstack.org/draft/swagger/compute-v2.1-swagger.json
http://developer.openstack.org/draft/swagger/data-processing-v1.1-swagger.json
http://developer.openstack.org/draft/swagger/database-v1-swagger.json
http://developer.openstack.org/draft/swagger/identity-admin-v2-swagger.json
http://developer.openstack.org/draft/swagger/identity-extensions-v2-swagger.json
http://developer.openstack.org/draft/swagger/identity-extensions-v3-swagger.json
http://developer.openstack.org/draft/swagger/identity-v2-swagger.json
http://developer.openstack.org/draft/swagger/identity-v3-swagger.json
http://developer.openstack.org/draft/swagger/image-v1-swagger.json
http://developer.openstack.org/draft/swagger/networking-extensions-v2-swagger.json
http://developer.openstack.org/draft/swagger/networking-v2-swagger.json
http://developer.openstack.org/draft/swagger/objectstorage-v1-swagger.json
http://developer.openstack.org/draft/swagger/orchestration-v1-swagger.json
http://developer.openstack.org/draft/swagger/share-v1-swagger.json
http://developer.openstack.org/draft/swagger/telemetry-v2-swagger.json

If you see a problem in the original WADL, log it here:
https://bugs.launchpad.net/openstack-api-site. If you see a problem with
the migration tool, log it here:
https://bugs.launchpad.net/openstack-doc-tools.

When will the work be completed?


I had hoped to have more to show by this point, but I await the infra
team's review of the server spec above, and we continue to work on the bugs
in the migration and output. Once the server spec work is complete, we can
release the draft site.

What if I have more questions?


You can always hop onto #openstack-doc or #openstack-sdks to ask me or
another API working group member for guidance.

Last but not least, if you want to learn more about Swagger in the upstream
contributors track at the Summit, vote for this session:
https://www.openstack.org/summit/austin-2016/vote-for-speakers/presentation/7723

Thanks,
Anne

--
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com

1.
http://specs.openstack.org/openstack/docs-specs/specs/mitaka/app-guides-mitaka-vision.html
2.
http://specs.openstack.org/openstack/docs-specs/specs/liberty/api-site.html


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

On 02/12/2016 03:45 PM, Anne Gentle wrote:
Hi all,
I wanted to give an update on the efforts to provide improved
application developer information on developer.openstack.org
. Wrangling this much valuable
information and gathering it in a way that helps people is no simple
matter. So. We move forward one step at a time.

It's the only way we can move around here. :)

What's new?

This week, with every build of the api-site, we are now running
fairy-slipper to migrate from WADL to Swagger for API reference
information. Those migrated Swagger files are then copied to
developer.openstack.org/draft/swagger
.

We know that not all files migrate smoothly. We'd love to get teams
looking at these migrated files. Thank you to those of you already
submitting fixes!

In addition, the infra team is reviewing a spec now so that we can serve
API reference information from the developer.openstack.org
site:
https://review.openstack.org/#/c/276484/

Why are we doing all this?


The overall vision is still intact in the original specifications
[1][2], however we need to do a lot of web design and front end work to
get where we want to be.

What can I do?


Check out these Swagger files.
http://developer.openstack.org/draft/swagger/blockstorage-v1-swagger.json
http://developer.openstack.org/draft/swagger/blockstorage-v2-swagger.json
http://developer.openstack.org/draft/swagger/clustering-v1-swagger.json
http://developer.openstack.org/draft/swagger/compute-v2.1-swagger.json
http://developer.openstack.org/draft/swagger/data-processing-v1.1-swagger.json
http://developer.openstack.org/draft/swagger/database-v1-swagger.json
http://developer.openstack.org/draft/swagger/identity-admin-v2-swagger.json
http://developer.openstack.org/draft/swagger/identity-extensions-v2-swagger.json
http://developer.openstack.org/draft/swagger/identity-extensions-v3-swagger.json
http://developer.openstack.org/draft/swagger/identity-v2-swagger.json
http://developer.openstack.org/draft/swagger/identity-v3-swagger.json
http://developer.openstack.org/draft/swagger/image-v1-swagger.json
http://developer.openstack.org/draft/swagger/networking-extensions-v2-swagger.json
http://developer.openstack.org/draft/swagger/networking-v2-swagger.json
http://developer.openstack.org/draft/swagger/objectstorage-v1-swagger.json
http://developer.openstack.org/draft/swagger/orchestration-v1-swagger.json
http://developer.openstack.org/draft/swagger/share-v1-swagger.json
http://developer.openstack.org/draft/swagger/telemetry-v2-swagger.json

If you see a problem in the original WADL, log it here:
https://bugs.launchpad.net/openstack-api-site. If you see a problem with
the migration tool, log it here:
https://bugs.launchpad.net/openstack-doc-tools.

When will the work be completed?


I had hoped to have more to show by this point, but I await the infra
team's review of the server spec above, and we continue to work on the
bugs in the migration and output. Once the server spec work is complete,
we can release the draft site.

K. I'll go review ...

What if I have more questions?

You can always hop onto #openstack-doc or #openstack-sdks to ask me or
another API working group member for guidance.

Last but not least, if you want to learn more about Swagger in the
upstream contributors track at the Summit, vote for this session:
https://www.openstack.org/summit/austin-2016/vote-for-speakers/presentation/7723

This is all super awesome Anne. Thanks for all the great work!


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

[openstack-dev] [horizon] [octavia] [heat] [docs] Meeting times and the -cp meeting room

Hi all,

The docs team has been seeking a new meeting time for North America/Europe
for a couple of months now. With that search comes the search for a meeting
room. Here's what we know:

We want Wed 20:00.

Heat, Horizon, and Octavia are currently in the three meeting rooms in the
time slot we want.

We've requested the use of #openstack-meeting-cp but there's some who
express a need for ad-hoc meeting times in that room.

The meetbot is enabled in #openstack-doc.

So, could we either use #openstack-meeting-cp or #openstack-doc? Or have
Heat, Horizon, or Octavia been looking for another time slot by chance?

Thanks for ideas.

Anne

--
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com


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

On Mon, Feb 22, 2016 at 8:49 AM, Anne Gentle annegentle@justwriteclick.com
wrote:

Hi all,

The docs team has been seeking a new meeting time for North America/Europe
for a couple of months now. With that search comes the search for a meeting
room. Here's what we know:

We want Wed 20:00.

Heat, Horizon, and Octavia are currently in the three meeting rooms in the
time slot we want.

We've requested the use of #openstack-meeting-cp but there's some who
express a need for ad-hoc meeting times in that room.

The meetbot is enabled in #openstack-doc.

So, could we either use #openstack-meeting-cp or #openstack-doc? Or have
Heat, Horizon, or Octavia been looking for another time slot by chance?

Thanks for ideas.

New idea: 1900 Wed. has free meeting rooms. I've updated the review, please
vote on this time:

https://review.openstack.org/271361

Thanks Andreas for looking!

Anne

Anne

--
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com

--
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com


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

[openstack-dev] [Docs] PTL Candidacy

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Hi everyone,

I am seeking re-election as Documentation PTL for Newton. I have now been the
docs PTL for two releases (Liberty and Mitaka), and would love another term in
the middle of the alphabet! We've achieved a lot this time around, including
an almost complete conversion to RST, quite a few structural overhauls of
popular books, and some fundamental toolchain improvements. There is still
lots to be done, though, and I would love your support to achieve this in
Newton.

During Liberty we got the bulk of our books migrated away from Docbook XML and
into RST. In Mitaka, we completed that work (with only the Ops Guide remaining
to be converted in Newton). For the last couple of releases, we've also had a
focus on improving the information architecture of our books, and have now
successfully completed overhauls of our most popular books, with the
Architecture Guide also well underway. All of these tasks will be carried over
to Newton, with many of them finally coming to completion. In Newton, I would
also like to address some of the larger issues around the organisation of our
documentation suite, making it easier for developers to contribute quality
code to our docs, and better welcoming and introducing new big tent projects
to the documentation team.

At the Mitaka summit in Tokyo, we decided to make a concerted effort to pay
down a lot of our tech debt, and one of the main ways we chose to do that was
to change the way we handled the DocImpact flag in our bugs. We merged those
changes to DocImpact about a month ago now, and it is already having a
significant impact on the amount of untriaged bugs outstanding. We're now much
more able to keep on top of our bug queue, which is giving us a much greater
ability to pay down tech debt. In this vein, we also have put a lot of effort
into ensuring new contributors have a better onboarding experience to docs,
with the creation of our new Contributor Guide which replaces a lot of old
wiki-based content, a great 'get started with docs' campaign at the last
Summit (which resulted in a hard copy article in the Summit edition of
SuperUser, and Anne and I on SuperUser TV), and a general willingness to
respond to questions on the mailing lists and help out new users wherever we
find them.

In the Liberty release cycle, we closed just over 600 bugs, and we're very
close to matching that number for Mitaka, with 505 bugs closed as I write
this. Again, we've managed to keep on top of the aging bugs as well, with all
bugs older than a year now closed. In the Mitaka release, we managed to close
16 blueprints, which is a massive increase over Liberty's 7.

I'm very excited about making the trek to Austin soon for the Newton summit,
to catch up with old friends, and hopefully meet some of our newest
contributors. Please be sure to stop for a chat if you see me around :)

I'd love to have your support for the PTL role for Newton, and I'm looking
forward to continuing to grow the documentation team.

Thanks,
Lana (@loquacities)


Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBCAAGBQJW5g++AAoJELppzVb4+KUy9LAH/RC5y/gM22qywGZaE2y4hWEc
b+xdCxFUuh41l3WJhQ2iRJrnZUjm84doG2eCIcCpJW/OC5udo+2GiQYGmLUH278A
uz8Rfglsu/SmDhWZbaIWtiKXo3WedmWzXUbBCV7/+aftphKLMdckD1KAharZZOWq
Jqzg56SjWRqzbO++XiciCVwQ+zgoGuzJzYEQ1SsYsAdp/+wdtO2qPORZO1UuoOfz
wFFS/OG8O4PsJa3e9KW/kHzDY3Emkz7bhqDcbE6w3HyszC6bEq8lDgmcXtg2SoNn
FzjEpoiiAyalncUfo3p+v+7CV/3M/N4nCB2K+VhYO0hIAxPgUMxhrP3jzzq/gSI=
=sboQ
-----END PGP SIGNATURE-----


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

[openstack-dev] [docs] [api] Oh Swagger, where art thou?

Hi all,

This release I’ve been communicating about moving from WADL to Swagger for
the API reference information on developer.openstack.org. What we've
discovered on the journey is that Swagger doesn't match well for our
current API designs (details below), and while we're not completely giving
up on Swagger, we're also recognizing the engineering effort to maintain
and sustain those efforts isn't going to magically appear.

Sean Dague has put together a proof-of-concept with Compute servers
reference documentation to use Sphinx, RST, parameters files, and some
Sphinx extensions to do a near-copy representation of the API reference
page. We've met with the Nova API team, the API working group, and other
interested developers to make sure our ideas are sound, and so far we have
consensus on forging a new path forward. The review patch is here:
https://review.openstack.org/#/c/292420.

I believe we can still find uses for the Swagger migration for some
projects that match the specification really well. We'll keep outputting
the draft Swagger files to http://developer.openstack.org/draft/swagger/
and continue to look for the use case for Swagger. Perhaps it's a
try-it-out connection to TryStack. Maybe some projects will want to build
clients from those files. We know it's useful, but need to focus efforts
for now.

We know that some OpenStack APIs cannot fit Swagger’s model. For example,
Compute, File Storage, Bare Metal, and Block Storage (nova, manila, ironic,
and cinder projects) have microversions enabled for updates to the request
body as we continue to evolve the API definition, and Swagger has no
mechanism to display the changes between microversions for end-users. As
another example, Compute, Block Storage, File Storage, Databases, and
Networks APIs (nova, cinder, manila, trove, and neutron projects) have an
/actions resource that allows multiple differing request bodies.

I'm writing this email to let you all know there's a new plan coming. We
are using pieces of work from the past efforts to get the best outcome for
sustainable, useful API documentation. The API Reference and WADL files
will remain in the api-site repo until we have a new publishing job that we
can use to flip the switch.

We'll be writing a new specification as well as presenting at an upstream
contributor's talk about Swagger as a standard:
https://www.openstack.org/summit/austin-2016/summit-schedule/events/7723
Once we get the publishing pipeline established, look for review proposals
to your project repos to store API docs there rather than in api-site.

We're going to reboot the migration and get off of WADL. Three cheers for
that. If you’d like to work on these efforts, please stay tuned to the
usual mailing list channels and if you are a docs or API working group
liaison, please stay up-to-date with the plans. Review the upcoming
specification, look for API docs patches in your repo, review those, and
keep the efforts moving.

I'll also attend this week's cross-project meeting to be available for any
questions during open discussion.

Thanks,
Anne, who is going to find her copy of the Oh Brother, Where Art Thou
soundtrack now

--
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com


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

[openstack-dev] [Docs] Austin Design Summit Sessions - Docs

Hi everyone,

First of all, thanks for the amazing feedback on what docs sessions you would like to see at the Austin Design Summit!

We have filled our entire allocation (and then some), and the schedule so far looks something like this:

Fishbowls (40 min slot) x 4

Mitaka retro - Wed 11
Toolchain/Infra session - Wed 16:30
Contributor Guide - Thu 9:50
Newton planning - Thu 13:30

Workrooms (40 min slot) x 4

API Guide Wed 9am
Install Guide - Wed 11:50
Security Guide - Thu 11
Networking Guide - Thu 11:50

Meetup (Friday 14:00-17:30)

Contributors meetup. No agenda.

And a note for those who noticed the Ops guide omission: this should take place in the Ops track, and I'll let you know when that session will be.

Lana

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

The docs sessions are now in Sched, complete with etherpad links: https://www.openstack.org/summit/austin-2016/summit-schedule/global-search?t=Documentation%3A

Note the Install Guide working session is on Wednesday at 11:50, timed so that we can run into lunch if required. I strongly suggest you attend if you have an opinion: https://www.openstack.org/summit/austin-2016/summit-schedule/events/9226

Lana

On 01/04/16 09:49, Lana Brindley wrote:
Hi everyone,

First of all, thanks for the amazing feedback on what docs sessions you would like to see at the Austin Design Summit!

We have filled our entire allocation (and then some), and the schedule so far looks something like this:

Fishbowls (40 min slot) x 4

Mitaka retro - Wed 11
Toolchain/Infra session - Wed 16:30
Contributor Guide - Thu 9:50
Newton planning - Thu 13:30

Workrooms (40 min slot) x 4

API Guide Wed 9am
Install Guide - Wed 11:50
Security Guide - Thu 11
Networking Guide - Thu 11:50

Meetup (Friday 14:00-17:30)

Contributors meetup. No agenda.

And a note for those who noticed the Ops guide omission: this should take place in the Ops track, and I'll let you know when that session will be.

Lana

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] What's Up, Doc? Mitaka Release Edition

Hi everyone,

While it was very tempting to write something something shocking here for April Fools', I thought everyone might have already had their heart rate raised enough by the fact that Mitaka is only five days away! This will be my final docs newsletter before the release, and the docs are in great shape ready to go out.

I would like to sincerely thank Andreas and our release managers Brian and Olga, not only for the hard work they've done so far, but also for holding down the fort over the next few days while I'm out of contact. Please remember to contact them directly if you have any last minute documentation fires that need putting out. I'd also like to mention the hard work that the Installation Guide testers have been putting in over the past couple of weeks. The testing matrix is looking very green (https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting) and I'm confident that we'll get the Mitaka guide out fully tested and on schedule.

Don't forget you can check release progress on the etherpad here: https://etherpad.openstack.org/p/MitakaRelease

== Progress towards Mitaka ==

5 days to go!

558 bugs closed so far for this release.

Docs Testing
* https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting
* Only a few items left to check off, at this stage we're good to publish the Ubuntu, RDO, and Suse guides on release day.

Release Tasks:
* Release planning occurs in our etherpad here: https://etherpad.openstack.org/p/MitakaRelease
* All tasks that should be completed at this stage are done, and we're on track to start the release process in the 24-48 hours before the release drops.
* Release notes for the docs project are in a "reno-style" directory in the openstack-manuals repo. This directory is not being managed by Reno, however, so please propose patches to it directly.

== The Road to Austin ==

  • First of all, thanks for the amazing feedback on what docs sessions you would like to see at the Austin Design Summit! We have filled our entire allocation (and then some), and the schedule so far is here: https://etherpad.openstack.org/p/Newton-DocsSessions
  • There's been a really robust and exciting conversation about the Install Guide on the dev list over the past week or so, which I have been following closely. If you're interested in overhauling our Install Guide (and it certainly seems like a lot of people are!), then please make sure you add our Install Guide Design Summit session to your agenda. It is on Wednesday at 11:50, so placed so that it can run over into lunchtime if required.
  • A note for those who noticed the Ops guide omission: this should take place in the Ops track, and I'll let you know when that session will be.

== Doc team meeting ==

Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-03-30

Next meetings:
APAC: No APAC meeting this week
US: Wednesday 13 April, 19:00 UTC (This is after the Mitaka release)

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#1_April_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] [api] [docs] WADL migration sign-up

Hi all,
Thanks to all those who groaned with me through the API docs working
session. :) I patched the instructions:
https://review.openstack.org/#/c/310514/

As promised, I've created this wiki page for people to sign up for a
migration task:

https://wiki.openstack.org/wiki/Documentation/Migrate#API_Reference_Plan

I've subscribed to changes on the page so I can keep track of who wants to
work on which services. Thanks so much!

Anne

--
Anne Gentle
www.justwriteclick.com


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

[openstack-dev] [Docs] Installation Guide Plans for Newton

Greetings from Austin!

Yesterday we held the Install Guide planning workgroup. It was a full room, with some very robust discussion, and I want to thank everyone for participating and sharing their thoughts on this matter. We have some solid goals to achieve for Newton now.

The etherpad with the discussion is here: https://etherpad.openstack.org/p/austin-docs-workgroup-install

The original spec to create a way for projects to publish Instal Guides has now been merged, thanks to consensus being achieved at the Design Summit session, and a few minor edits: https://review.openstack.org/#/c/301284/ We can now begin work on this.

There is a new spec up to cover the remainder of the work to be done on the existing Install Guide: https://review.openstack.org/#/c/310588 This still needs some iterations to get it into shape (including determining the name we are going to use for the Install Guide). So, patches welcome.

Again, thank you to all the many people who attended the session, and those who have found me this week and discussed the future of the Install Guide. I'm confident that this plan has broad acceptance, is achievable during the Newton cycle, and it moves the documentation project forward.

Feedback is, as always, very welcome.

Lana

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] [api] [docs] [cinder] [swift] [glance] [keystone] [ironic] [trove] [neutron] [heat] [senlin] [manila] [sahara] RST + YAML files ready for pick up from WADL migration

Hi all,
This patch contains all the RST + YAML for projects to bring over to their
repos to begin building API reference information from within your repo.
Get a copy of this patch, and pick up the files for your service in
api-site/api-ref/source/:

https://review.openstack.org/#/c/311596/

There is required cleanup, and you'll need an index.rst, conf.py, and build
jobs. All of these can be patterned after the nova repository api-ref
directory. Read more at
http://docs.openstack.org/contributor-guide/api-guides.html

It's overall in good shape thanks to Karen Bradshaw, Auggy Ragwitz, Andreas
Jaeger, and Sean Dague. Appreciate the help over the finish line during
Summit week, y'all.

The api-site/api-ref files are now frozen and we will not accept patches.
The output at developer.openstack.org/api-ref.html remains frozen until we
can provide redirects to the newly-sourced-and-built files. Please, make
this work a priority in this release. Ideally we can get everyone ready by
Milestone 1 (May 31).

If you would like to use a Swagger/OpenAPI file, pick that file up from
developer.openstack.org/draft/swagger/ and create build jobs from your repo
to publish it on developer.openstack.org.

Let me know if you have questions.
Thanks,
Anne

--
Anne Gentle
www.justwriteclick.com


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

Hi Anne,

Sure, I will pick for cinder.

Thanks!!

Best Regards,
Sheel Rana

On Tue, May 3, 2016 at 6:59 PM, Anne Gentle annegentle@justwriteclick.com
wrote:

Hi all,
This patch contains all the RST + YAML for projects to bring over to their
repos to begin building API reference information from within your repo.
Get a copy of this patch, and pick up the files for your service in
api-site/api-ref/source/:

https://review.openstack.org/#/c/311596/

There is required cleanup, and you'll need an index.rst, conf.py, and
build jobs. All of these can be patterned after the nova repository api-ref
directory. Read more at
http://docs.openstack.org/contributor-guide/api-guides.html

It's overall in good shape thanks to Karen Bradshaw, Auggy Ragwitz,
Andreas Jaeger, and Sean Dague. Appreciate the help over the finish line
during Summit week, y'all.

The api-site/api-ref files are now frozen and we will not accept patches.
The output at developer.openstack.org/api-ref.html remains frozen until
we can provide redirects to the newly-sourced-and-built files. Please, make
this work a priority in this release. Ideally we can get everyone ready by
Milestone 1 (May 31).

If you would like to use a Swagger/OpenAPI file, pick that file up from
developer.openstack.org/draft/swagger/ and create build jobs from your
repo to publish it on developer.openstack.org.

Let me know if you have questions.
Thanks,
Anne

--
Anne Gentle
www.justwriteclick.com


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


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

[openstack-dev] What's Up, Doc? 6 May 2016

Hi everyone,

I hope you all had a safe journey home from Summit, and are now fully recovered from all the excitement (and jetlag)! I'm really pleased with the amount of progress we made this time around. We have a definitive set of goals for Newton, and I'm confident that they're all moving us towards a much better docs suite overall. Of course, the biggest and most important work we have to do is to get our Install Guide changes underway. I'm very excited to see the new method for documenting OpenStack installation, and can't wait to see all our big tent projects contributing to docs in such a meaningful way. Thank you to everyone (in the room and online) who contributed to the Install Guide discussion, and helped us move forward on this important project.

In other news, I've written a wrapup of the Austin design summit on my blog, which you might be interested in: http://lanabrindley.com/2016/05/05/openstack-newton-summit-docs-wrapup/

== Progress towards Newton ==

152 days to go!

Bugs closed so far: 61

Because we have such a specific set of deliverables carved out for Newton, I've made them their own wiki page: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
Feel free to add more detail and cross things off as they are achieved throughout the release. I will also do my best to ensure it's kept up to date for each newsletter.

One of the first tasks we've started work on after Summit is moving the Ops and HA Guides out of their own repositories and into openstack-manuals. As a result, those repositories are now frozen, and any work you want to do on those books should be in openstack-manuals.

We are almost ready to publish the new RST version of the Ops Guide, there's just a few cleanup edits going in now, so make sure you have the right book, in the right repo from now on. This was our very last book remaining in DocBook XML, so the docs toolchain will be removing DocBook XML support. See spec https://review.openstack.org/311698 for details.

Another migration note is that the API reference content is moving from api-site to project specific repositories and api-site is now frozen. For more detail, see Anne's email: http://lists.openstack.org/pipermail/openstack-docs/2016-May/008536.html

== Mitaka wrapup ==

We performed a Mitaka retrospective at Summit, notes are here: https://etherpad.openstack.org/p/austin-docs-mitakaretro

In particular, I'd like to call out our hard working tools team Andreas and Christian, all our Speciality Team leads, and the Mitaka release managers Brian and Olga. Well done on a very successful release, everyone :)

Total bugs closed: 645

== Site Stats ==

Thanks to the lovely people at Foundation (thanks Allison!) I now have access to more stats than I could possibly guess what to do with, and I'm hoping to be able to share some of these with you through the newsletter. If there's something in particular you would like to see, then please let me know and I'll endeavour to record it here!

So far I can tell you that docs.openstack.org had 1.63M unique pageviews in April, down slightly from 1.72M in March, and the average session duration is just over six minutes, looking at just under 4 pages per session.

== Doc team meeting ==

Next meetings:

We'll be restarting the meeting series next week.

Next meetings:
US: Wednesday 11 April, 19:00 UTC
APAC: Wednesday 18 April, 00:30 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#6_May_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

Hi Lana,

Thanks for the summary, it's pretty good reading to catch up what happened recently.

I have one question, I might missed a few entries, so please point me to the right document in this case. We had a docco session with the Telemetry team and we agreed on moving back the documentation snippets, like for instance the Install Guide, to the project trees is a really good step and we're very supportive. In this sense I would like to ask about the plans regarding the Admin guide. We have a chapter there, which is on one hand outdated and on the other hand would be better to move under the project trees as well. Is this plan/desire in line with your plans regarding that document?

Thanks,
/Ildikó

-----Original Message-----
From: Lana Brindley [mailto:openstack@lanabrindley.com]
Sent: May 06, 2016 08:13
To: enstack.org; OpenStack Development Mailing List; openstack-i18n@lists.openstack.org
Subject: What's Up, Doc? 6 May 2016

Hi everyone,

I hope you all had a safe journey home from Summit, and are now fully recovered from all the excitement (and jetlag)! I'm really
pleased with the amount of progress we made this time around. We have a definitive set of goals for Newton, and I'm confident that
they're all moving us towards a much better docs suite overall. Of course, the biggest and most important work we have to do is to get
our Install Guide changes underway. I'm very excited to see the new method for documenting OpenStack installation, and can't wait
to see all our big tent projects contributing to docs in such a meaningful way. Thank you to everyone (in the room and online) who
contributed to the Install Guide discussion, and helped us move forward on this important project.

In other news, I've written a wrapup of the Austin design summit on my blog, which you might be interested in:
http://lanabrindley.com/2016/05/05/openstack-newton-summit-docs-wrapup/

== Progress towards Newton ==

152 days to go!

Bugs closed so far: 61

Because we have such a specific set of deliverables carved out for Newton, I've made them their own wiki page:
https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
Feel free to add more detail and cross things off as they are achieved throughout the release. I will also do my best to ensure it's kept
up to date for each newsletter.

One of the first tasks we've started work on after Summit is moving the Ops and HA Guides out of their own repositories and into
openstack-manuals. As a result, those repositories are now frozen, and any work you want to do on those books should be in
openstack-manuals.

We are almost ready to publish the new RST version of the Ops Guide, there's just a few cleanup edits going in now, so make sure you
have the right book, in the right repo from now on. This was our very last book remaining in DocBook XML, so the docs toolchain will
be removing DocBook XML support. See spec https://review.openstack.org/311698 for details.

Another migration note is that the API reference content is moving from api-site to project specific repositories and api-site is now
frozen. For more detail, see Anne's email: http://lists.openstack.org/pipermail/openstack-docs/2016-May/008536.html

== Mitaka wrapup ==

We performed a Mitaka retrospective at Summit, notes are here: https://etherpad.openstack.org/p/austin-docs-mitakaretro

In particular, I'd like to call out our hard working tools team Andreas and Christian, all our Speciality Team leads, and the Mitaka release
managers Brian and Olga. Well done on a very successful release, everyone :)

Total bugs closed: 645

== Site Stats ==

Thanks to the lovely people at Foundation (thanks Allison!) I now have access to more stats than I could possibly guess what to do
with, and I'm hoping to be able to share some of these with you through the newsletter. If there's something in particular you would
like to see, then please let me know and I'll endeavour to record it here!

So far I can tell you that docs.openstack.org had 1.63M unique pageviews in April, down slightly from 1.72M in March, and the average
session duration is just over six minutes, looking at just under 4 pages per session.

== Doc team meeting ==

Next meetings:

We'll be restarting the meeting series next week.

Next meetings:
US: Wednesday 11 April, 19:00 UTC
APAC: Wednesday 18 April, 00:30 UTC

Please go ahead and add any agenda items to the meeting page here:
https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#6_May_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] [api] [senlin] [keystone] [ceilometer] [telemetry] Questions about api-ref launchpad bugs

Great questions, so I'm copying the -docs and -dev lists to make sure
people know the answers.

On Tue, May 10, 2016 at 5:14 AM, Atsushi SAKAI sakaia@jp.fujitsu.com
wrote:

Hello Anne

I have several question when I am reading through etherpad's (in
progress).
It would be appreciated to answer these questions.

1)Should api-ref launchpad bugs be moved to each modules
(like keystone, nova etc)?
Also, this should be applied to moved one's only or all components?
(compute, baremetal Ref.2)

Ref.
https://etherpad.openstack.org/p/austin-docs-newtonplan
API site bug list cleanup: move specific service API ref bugs to
project's Launchpad

Ref.2
http://developer.openstack.org/api-ref/compute/
http://developer.openstack.org/api-ref/baremetal/

Yes! I definitely got agreement from nova team that they want them. Does
anyone have a Launchpad script that could help with the bulk filter/export?
Also, are any teams concerned about taking on their API reference bugs?
Let's chat.

2)Status of API-Ref
a)Why keystone and senlin are no person at this moment?

Keystone -- after the Summit, keystone had someone sign up [1], but sounds
like we need someone else. Brant, can you help us find someone?

Senlin -- Qiming Teng had asked a lot of questions earlier in the process
and tested the instructions. Qiming had good concerns about personal
bandwidth limits following along with all the changes. Now that it's
settled, I'll follow up (and hoping the senlin team is reading the list).

b)What is your plan for sahara and ceilometer?
(It seems already exist the document.)

Yes, these are two I had seen already have RST, but they do not use the
helpful Sphinx extensions.

Sahara -- Mike McCune, we should chat about the plans. Are you okay with
moving towards the common framework and editing the current RST files to
use the restmethod and restparameters Sphinx directives?

Ceilometer -- sorry, Julien, I hadn't reached out individually to you.
Could you let me know your plans for the RST API reference docs?

c)When is the table's status changed to "Done"?
nova (compute) and ironic (baremetal) seems first patch merged
and see the document already.

I'll change those two to Done.

Thanks for asking -
Anne

--
Anne Gentle
www.justwriteclick.com


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

On Tue, May 10 2016, Anne Gentle wrote:

Ceilometer -- sorry, Julien, I hadn't reached out individually to you.
Could you let me know your plans for the RST API reference docs?

For Gnocchi and Aodh, we want to move to whatever the new format is and
build a reference description in our tree (so we can maintain and update
it as we go). I heard Swagger is the way to go, so that's we're going to
look into – unless someone redirects us.

For examples of usage of our APIs, we have a documentation built
dynamically within the documentation for Gnocchi (see
http://gnocchi.xyz/rest.html). Real HTTP calls are being made to
generate that documentation, so no replies are hand written. That makes
us sure that the documentation is always up-to-date.
We may want to also implement that in Aodh at some point.

For Ceilometer, I don't think we want to put much effort in it. The v2
API is being deprecated and slowly moved out of our way. The /v2/events
API is being moved in a 4th project, named Panko, that will follow
Gnocchi & Aodh in term of documentation.

I hope that'll clarify things!

Cheers,
--
Julien Danjou
;; Free Software hacker
;; https://julien.danjou.info


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

[openstack-dev] What's Up, Doc? 13 May

= 13 May 2016 =

Hi everyone,

Wow, what a busy week! I've been mainly focused on the Install Guide speciality team this week, with gathering interested participants, ensuring our specs are ready to be merged, and setting a new meeting time. I'm also pleased to say that our speciality team reports make a post-Summit comeback in this newsletter.

Just another reminder that all projects should update their cross-project liaison for docs on the wiki here: https://wiki.openstack.org/wiki/CrossProjectLiaisons#Documentation If you're one of the lucky people nominated by your PTL to be a docs CPL, then please do your very best to attend docs meetings in your favourite timezone to make sure we hear the voice of your project when we're making documentation decisions. Details of upcoming docs meetings are at the end of this newsletter every week.

On a related note, it was refreshing to read the conversation from the US meeting this week, and the associated conversation on the mailing lists about developer contributions to documentation. We'd love to find out what it is that prevents you from contributing to the docs, and what the docs team can do to make things that little bit easier for you! Reach out to us either on the dev mailing list (with [docs] in the subject line), or on the docs mailing list at openstack-docs@lists.openstack.org.

== Progress towards Newton ==

145 days to go!

Bugs closed so far: 71

Newton deliverables https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
Feel free to add more detail and cross things off as they are achieved throughout the release. I will also do my best to ensure it's kept up to date for each newsletter.

The Ops and HA Guides now exist in openstack-manuals, and the old repos have now been set to read-only.

We also have the first patch in for the Install Guide 'cookie cutter' template, which is a great start!

== Speciality Team Reports ==

'''HA Guide: Bogdan Dobrelya'''
No report this week.

'''Install Guide: Lana Brindley'''
New meeting time proposed: https://review.openstack.org/#/c/314831/ Still need to merge final spec: https://review.openstack.org/#/c/310588/ If you're interested in helping out, add your name here: https://wiki.openstack.org/wiki/Documentation/InstallGuide#Team_members

'''Networking Guide: Edgar Magana'''
We are planning to resume the meeting next week.

'''Security Guide: Nathaniel Dillon'''
Summit Recap: https://etherpad.openstack.org/p/austin-docs-workgroup-security
Good conversations around API rate limiting, OSSN in-flight, SecGuide work being prep'd (Thanks to Luke Hinds for taking this on!)
Added Doc reviewer (Thanks Shilla and welcome!)
Will be focusing on Neutron security

'''User Guides: Joseph Robinson'''
No report this week.

'''Ops Guide: Shilla Saebi'''
Proposed architecture guide restructure: https://review.openstack.org/#/c/311998/
Ops guide session Etherpad from Austin: https://etherpad.openstack.org/p/AUS-ops-Docs-ops-guide
OpsGuide reorg: https://etherpad.openstack.org/p/PAO-ops-ops-guide-fixing
Newton Plans:
Review content of both guides, and delete anything out of date
Review architecture of both guides, and possibly combine
Ops Guide in openstack-manuals repo
Gather content from Ops internal documentation

'''API Guide: Anne Gentle'''
All but two services have someone working on landing a migration patch in the project's repo.
Read: Status on bugs and migration http://lists.openstack.org/pipermail/openstack-docs/2016-May/008624.html
Read: Summit session recap http://lists.openstack.org/pipermail/openstack-dev/2016-May/094472.html

'''Config/CLI Ref: Tomoyuki Kato'''
Discussing documenting auto generation of config options with Oslo team.
Dropped keystone command-line client from CLI reference.
Keystone CLI was removed in python-keystoneclient 3.0.0 release.

'''Training labs: Pranav Salunke, Roger Luethi'''
Working on adding new features like PXE boot.
Stabilizing current release and backends.
Figuring out the zip file generation and web site/page.
Chaging the meeting time to more CET/CEST friendly time.

'''Training Guides: Matjaz Pancur'''
No report this week.

'''Hypervisor Tuning Guide: Joe Topjian'''
No report this week.

'''UX/UI Guidelines: Michael Tullis, Stephen Ballard'''
No report this week.

== Site Stats ==

The interesting fact I'd like to share with you this week is that just over 25% of our viewers this month are new to the site.

== Doc team meeting ==

Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-05-11

Next meetings:
APAC: Wednesday 18 May, 00:30 UTC
US: Wednesday 25 May, 19:00 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#13_May_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] [openstack-docs][training-labs] Changing Training Labs IRC Team Meeting Time

Hello,

I would like to notify that the training labs core team has decided to
change the timezone for the IRC team meeting to better suit CET/CEST to
consider the time zone of most of the core team. If anyone has some
objections or questions please raise them soon.

Upstream Patch: https://review.openstack.org/#/c/314998/5

Regards,
Pranav


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

[openstack-dev] What's Up, Doc? 27 May 2016

Hi everyone,

This week I've been focused on getting the Install Guide project back up and running, with the team meeting being rebooted, our specs finally merged, and organising the list of tasks to be getting on with. Also, don't forget to vote in our naming poll: http://goo.gl/forms/Eqf9WOGqsXjkRbdc2 I'm still very much in need of representatives from the various project teams to pitch in and help us get things running. Please make sure your project is represented by coming along to meetings, or at least contacting us through the mailing list.

In other news, the Ops and Arch Guide re-architecture is proceeding apace. Specs were merged this week, and the new Arch Guide ToC is looking great! Check it out here: http://specs.openstack.org/openstack/docs-specs/specs/newton/arch-guide-restructure.html We are also still looking for feedback on the current Ops guide. Add your notes here: https://etherpad.openstack.org/p/ops-guide-reorg

== Progress towards Newton ==

131 days to go!

Bugs closed so far: 107

Newton deliverables https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
Feel free to add more detail and cross things off as they are achieved throughout the release.

== Speciality Team Reports ==

'''HA Guide: Bogdan Dobrelya'''
No report this week.

'''Install Guide: Lana Brindley'''
Specs are now merged, an blueprints created. Tasks listed here: https://wiki.openstack.org/wiki/Documentation/InstallGuideWorkItems Please go ahead and pick up work items. Need project representation in meetings. Next meeting: Tue 7 June 0600 UTC

'''Networking Guide: Edgar Magana'''
We did not have meeting this week. Nothing to report. Next IRC meeting: Thursday June 2nd at 1600 UTC

'''Security Guide: Nathaniel Dillon'''
No report this week.

'''User Guides: Joseph Robinson'''
Action items to follow up - email meeting minutes to the mailing list to update the community.
Currently, the team has two contributors. Please let me know if you're interested in working on the User Guide Team.

'''Ops Guide: Shilla Saebi'''
Shilla & Darren working on collecting enterprise docs to push upstream
Ops tasks are documented here: https://etherpad.openstack.org/p/ops-arch-tasks
OpenStack ops guide reorg in progress & documented here: https://etherpad.openstack.org/p/ops-guide-reorg
Spec was merged: https://review.openstack.org/#/c/311998/

'''API Guide: Anne Gentle'''
No report this week.

'''Config/CLI Ref: Tomoyuki Kato'''
A few configuration docs patches for some vendor plug-ins has been merged, with mitaka backport.
Heat CLI is marked as deprecated.

'''Training labs: Pranav Salunke, Roger Luethi'''
No report this week.

'''Training Guides: Matjaz Pancur'''
Updates for Upstream training material

'''Hypervisor Tuning Guide: Blair Bethwaite
No report this week.

'''UX/UI Guidelines: Michael Tullis, Stephen Ballard'''
No report this week.

== Site Stats ==

This month, two thirds of our site visitors have been using their Mac to read the docs. Just under 30% used Windows, and Linux rounded out the remainder at 4%.

So far in the Install Guide naming poll, "OpenStack Installation Tutorial" has a commanding lead at 30%, with "Basic Install Guide" and "OpenStack Evaluation Setup Guide" (try saying that ten times fast!) tying for second place with 17% of the vote each. I'll keep the poll open for another week or so, and announce our winning name in next week's newsletter.

== Doc team meeting ==

Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-05-25

Next meetings:
APAC: Wednesday 1 June, 00:30 UTC
US: Wednesday 8 June, 19:00 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#27_May_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

Re: [openstack-dev] [networking-guide] First IRC meeting tomorrow

Folks,

This is a kind reminder that we are having our IRC meeting tomorrow at 1600 UTC in #openstack-meeting
Agenda:
https://etherpad.openstack.org/p/docnetworkingteam-agenda

Thanks,

Edgar


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

[openstack-dev] What's Up, Doc? 3 June 2016

Hi everyone,

I'm very pleased to be able to announce the results of our Install Guide naming poll this week. We ended up with 31 responses, and a very clear winner in "OpenStack Installation Tutorial". Thank you to everyone who voted! Also, just a note that I'm still very much in need of representatives from the various project teams to pitch in and help us get things running. Please make sure your project is represented by coming along to meetings, or at least contacting us through the mailing list.

This week I've also spent some time with the Upstream training team, identifying gaps in the current material, and preparing for Barcelona.

== Progress towards Newton ==

124 days to go!

Bugs closed so far: 134

Newton deliverables https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
Feel free to add more detail and cross things off as they are achieved throughout the release.

== Speciality Team Reports ==

'''HA Guide: Bogdan Dobrelya'''
No report this week.

'''Install Guide: Lana Brindley'''
Poll concluded, winner is "OpenStack Installation Tutorial". Connected with CPLs this week to encourage more participation. Next meeting: Tue 7 June 0600 UTC.

'''Networking Guide: Edgar Magana'''
Moved DHCP HA chapter to Networking Guide for better maintenance and updates. Planning to move more sections and focus on DVR HA. Suffering of very low attendance for the IRC meeting.

'''Security Guide: Nathaniel Dillon'''
No report this week.

'''User Guides: Joseph Robinson'''
Some contact with the Magnum team. Held meetings, brought up the link changes, which is something I most need some assistance with. IA plan still forthcoming.

'''Ops Guide: Shilla Saebi'''
No report this week.

'''API Guide: Anne Gentle'''
New layout for API reference docs from additions to openstackdocs theme. Also already added four-color scheme for GET/PUT/POST/DELETE Thanks Graham Hayes! Work in progress here: https://api.os.gra.ham.ie/compute/
Reviews: https://review.openstack.org/#/q/project:openstack/openstackdocstheme+status:open and https://review.openstack.org/#/q/project:openstack/os-api-ref+status:open
Discussion on SDKs and FirstApp audience happening on user-committee list: http://lists.openstack.org/pipermail/user-committee/2016-May/000889.html

'''Config/CLI Ref: Tomoyuki Kato'''
Closed some bugs with Mitaka backport. Fixed the incorrect RST markup at the new options section, with generation tool update.

'''Training labs: Pranav Salunke, Roger Luethi'''
No report this week.

'''Training Guides: Matjaz Pancur'''
Upstream training updates, Barcelona schedule.

'''Hypervisor Tuning Guide: Blair Bethwaite
No report this week.

'''UX/UI Guidelines: Michael Tullis, Stephen Ballard'''
The first prototype of content was presented and source information gaps were identified. A first draft will be complete by June 9.

== Site Stats ==

In the Install Guide naming poll, "OpenStack Installation Tutorial" finished with 29% of the vote, well ahead of "OpenStack Evaluation Setup Guide" at 19%, and "Basic Install Guide" at 16%. And, because charts are fun, here are the final results: https://docs.google.com/spreadsheets/d/1VlNFebI_KFobs-XIT5oRhULRymwrqON8SV9pH4uiYIQ/pubchart?oid=2070399201&format=image

I personally thought "OpenStack from Scratch" was the most creative title. And the potentially confusing "Manual Install Guide" ("Guided Install Manual"?) had a small following at just under 10% of the vote. Thanks for all the great suggestions :)

== Doc team meeting ==

Next meetings:

The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-06-01

Next meetings:
US: Wednesday 8 June, 19:00 UTC
APAC: Wednesday 15 June, 00:30 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#3_June_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] What's Up, Doc? 10 June 2016

Hi everyone,

My week has been spent on the Install Guide, and a big thanks to Andreas for getting the Infra patch up and documenting the new process. The Install Guide team meeting was well attended this week, and I've been following up on the actions from that. I also contacted the cross project liaisons with the information they need to get their content moved, and I'm looking forward to seeing some of these start work next week.

In other news, Joseph has been busy reviewing the User Guides, and could use a little help working on the information architecture, and getting a few new projects documented. User Guide meetings are held in US and APAC timezones and volunteers are essential to get this effort complete for Newton. Get all the info here: https://wiki.openstack.org/wiki/User_Guides

== Progress towards Newton ==

117 days to go!

Bugs closed so far: 163

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
Feel free to add more detail and cross things off as they are achieved throughout the release.

== Speciality Team Reports ==

'''HA Guide: Bogdan Dobrelya'''
No report this week.

'''Install Guide: Lana Brindley'''
Infra patch: https://review.openstack.org/#/c/326039/ Instructions: http://docs.openstack.org/contributor-guide/project-install-guide.html Next meeting: Tue 21 June 0600 UTC

'''Networking Guide: Edgar Magana'''
No meeting this week. Working on a better ToC for the guide that may impact of the of scenarios.
Moving more networking content from other guides into the Networking one in order to keep everything in one central point and better updated.

'''Security Guide: Nathaniel Dillon'''
No report this week.

'''User Guides: Joseph Robinson'''
Outstanding Tasks - Contacting more project teams for inclusion status, IA plans for the new guide. Some team discussion on fixing old links - contact me if anyone is interested in contributing more content to the User Guides team.

'''Ops Guide: Shilla Saebi'''
Ops tasks are documented here: https://etherpad.openstack.org/p/ops-arch-tasks OpenStack ops guide reorg in progress & documented here: https://etherpad.openstack.org/p/ops-guide-reorg Working on posting enterprise docs for cleanup. Looking for volunteers in ops/arch docs group to attend ops specific meetings to find additional info and help.

'''API Guide: Anne Gentle'''
Call for help for unified all-OpenStack API navigation design: http://lists.openstack.org/pipermail/openstack-docs/2016-June/008730.html
Discussing project-level organization in https://review.openstack.org/312259
Discussing source organization in https://review.openstack.org/314819
Redirects and deletions in api-site are welcomed! For example, see https://review.openstack.org/327399
Updated README for api-site: https://review.openstack.org/327395

'''Config/CLI Ref: Tomoyuki Kato'''
Closed a few bugs continuously. Cleaned up many bugs about tool-generated configuration options that are already released for Mitaka. We need folks for vendor plug-in docs from each vendor.

'''Training labs: Pranav Salunke, Roger Luethi'''
Working on the training-labs landing page to make it look much better. Reintroducing the tooling to build zip files. Working on PXE support for baremetal provisioning. Working on Python port of training-labs.

'''Training Guides: Matjaz Pancur'''
No report this week.

'''Hypervisor Tuning Guide: Blair Bethwaite
No report this week.

'''UX/UI Guidelines: Michael Tullis, Stephen Ballard'''
No report this week.

== Site Stats ==

During May, the docs.openstack.org site had 620 sessions, with just under 20% by new users. The average time of all sessions for the month was about 5 and a half minutes, looking at an average of 3 and a half pages.

== Doc team meeting ==

Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-06-08

Next meetings:
APAC: Wednesday 15 June, 00:30 UTC
US: Wednesday 22 June, 19:00 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#10_June_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] What's Up, Doc? 17 June 2016

Hi everyone,

This week I've very pleased to announce that we have our first project-specific Install Guide published! Petr Kovar got Heat over the line in first place, and it's looking great: http://docs.openstack.org/project-install-guide/orchestration/draft/index.html Well done Petr, and of course all the wonderful docs people who helped us get to this point. We're also expecting to see Trove published very soon. I've been using the lessons learned from these early projects to flesh out our instructions a little more, so it should be even easier for projects to get their Install Guides up and running. We still need to create the central index, but it's all starting to come together now.

I'm also excited to announce that, for the very first time, we have a specific Ops Cross-Project Liaison. Please welcome Robert Starmer to the CPL family :)

== Progress towards Newton ==

110 days to go!

Bugs closed so far: 185

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
Feel free to add more detail and cross things off as they are achieved throughout the release.

Also, just a note that the CFP for Barcelona is open now, until 13 July. If you want to brainstorm some documentation-related ideas, please get in touch!

== Speciality Team Reports ==

'''HA Guide: Bogdan Dobrelya'''
No report this week.

'''Install Guide: Lana Brindley'''
Orchestration is done! Well done, Petr :) Working on updating instructions in the Contributor Guide. Instructions: http://docs.openstack.org/contributor-guide/project-install-guide.html Next meeting: Tue 21 June 0600 UTC

'''Networking Guide: Edgar Magana'''
No report this week.

'''Security Guide: Nathaniel Dillon'''
No report this week.

'''User Guides: Joseph Robinson'''
Began a consistency and IA plan, and held the US meeting. Emailing one new interested contributor.

'''Ops Guide: Darren Chan'''
Some architecture content moved from the Ops Guide to the draft Arch Guide. Patches will be submitted to remove old content from the Ops Guide. Team is currently reviewing enterprise ops documentation to incorporate into the Ops Guide.

'''API Guide: Anne Gentle'''
Check out all the open reviews for api-ref: https://review.openstack.org/#/q/status:open+file:api-ref Nice.
Went to weekly team meeting for swift, landed build patch for swift's api-ref, responding to reviews.
Noodling with Karen Bradshaw about API navigation, https://review.openstack.org/#/c/329508/ (though I can't take any credit for the work!)

'''Config/CLI Ref: Tomoyuki Kato'''
Closed many bugs continuously. Started working on the common configurations for shared services and libraries.

'''Training labs: Pranav Salunke, Roger Luethi'''
No report this week.

'''Training Guides: Matjaz Pancur'''
No report this week.

'''Hypervisor Tuning Guide: Blair Bethwaite
No report this week.

'''UX/UI Guidelines: Michael Tullis, Stephen Ballard'''
No report this week.

== Training Guides/Labs Core Team Changes ==

We've adjusted the training guides and labs core teams so that speciality team leads are core in their own repos, and the docs core team is an 'included group' in both repos. This is intended to stop the core teams for these groups drifting out of date too quickly. Note that it is expected that docs cores will not be the primary reviewers/mergers for training repos, but are there as backup in case extra eyes are needed. That responsibility will continue to lie with the training teams themselves, as they know the codebase the best.

You can see the updated core team lists here:
Training Guides: https://review.openstack.org/#/admin/groups/uuid-3490bf37012cb344104cb315f3dd5c76dabea62f,members
Training Labs: https://review.openstack.org/#/admin/groups/1118,members

== Site Stats ==

During May the top viewed book was the Mitaka Ubuntu Install Guide, followed closely by the Mitaka RDO Install Guide. Rolling into third place was the Admin Guide.

Also, apologies for an error I made in this section last week. The correct number for the total number of views in May was 2,365,626.

== Doc team meeting ==

Next meetings:

The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-06-15

Next meetings:
US: Wednesday 22 June, 19:00 UTC
APAC: Wednesday 29 June, 00:30 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#17_June_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] What's Up, Doc? 24 June 2016

Hi everyone,

We're starting to see a real rush of projects publishing their Install Guides this week, which is really exciting! We're also working on getting the index page on docs.openstack.org up and running, so we should have that ready to go up by the time I'm writing this newsletter next week. Well done to all the docs people, and the cross-project liaisons who have been working hard to make this happen. It's great to see it all start to come together :)

== Progress towards Newton ==

103 days to go!

Bugs closed so far: 207

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
Feel free to add more detail and cross things off as they are achieved throughout the release.

Also, just a note that the CFP for Barcelona is open now, until 13 July. If you want to brainstorm some documentation-related ideas, please get in touch!

== Speciality Team Reports ==

'''HA Guide: Bogdan Dobrelya'''
No report this week.

'''Install Guide: Lana Brindley'''
Swift, Manila patches in progress. Petr is working on the index page: https://review.openstack.org/331704 Feedback requested! Next meeting: 5 July 0600 UTC

'''Networking Guide: Edgar Magana'''
No report this week.

'''Security Guide: Nathaniel Dillon'''
No report this week.

'''User Guides: Joseph Robinson'''
No report this week.

'''Ops Guide: Shilla Saebi'''
Team is currently reviewing enterprise ops documentation to incorporate into the Ops Guide.
Ops tasks are documented here: https://etherpad.openstack.org/p/ops-arch-tasks
OpenStack ops guide reorg in progress & documented here: https://etherpad.openstack.org/p/ops-guide-reorg
Members of the ops guide team are joining ops meetings to find volunteers

'''API Guide: Anne Gentle'''
Progress ongoing on navigation for multiple OpenStack APIs: https://review.openstack.org/#/c/329508
Working on lists of project's API references that don't use RST+YAML framework: http://lists.openstack.org/pipermail/openstack-docs/2016-June/008775.html

'''Config/CLI Ref: Tomoyuki Kato'''
Got some comments for improvements from Brian Rosmaita, Hemanth Makkapati and Richard Jones. Thank you!
Closed many bugs for Configuration Reference.
Updated openstack, glance, neutron-sanity-check, and trove-manage CLI reference.

'''Training labs: Pranav Salunke, Roger Luethi'''
Webpage is looking good and also all the URL's point to the right link http://docs.openstack.org/training_labs/
Trying to finalize PXE support https://review.openstack.org/#/c/305991/

'''Training Guides: Matjaz Pancur'''
Italian translation of the Upstream training
Details about running a Lego session (https://review.openstack.org/#/c/325020/, https://review.openstack.org/#/c/330819/)

'''Hypervisor Tuning Guide: Blair Bethwaite
No report this week.

'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
No report this week.

== Site Stats ==

The top five search terms on the site so far during June: snapshot, cinder, nova, security group, quota

== Doc team meeting ==

Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-06-22

Next meetings:
APAC: Wednesday 29 June, 00:30 UTC
US: Wednesday 6 July, 19:00 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#24_June_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] [telemetry] Ceilometer and Aodh install guide(s)

Hi,

I'm currently working on to move the Install Guide for Ceilometer [1] and Aodh [2] under the project trees. I faced with a few difficulties so far about which I would like to ask your opinion.

First of all these two projects are under the Telemetry umbrella, so they are not completely separate. I tried to name the services in the documents accordingly in the files. My question here would be whether these two guides will be included in the overall document as two totally standalone services or we can link them together somehow?

The other question I had in mind is in connection with removing ".. only::". As Ceilometer is integrated with several other projects it needs additional configuration steps, where we have distro specific steps to follow. I chose the direction of extracting the common parts and reused them in the distro specific files. The end result still looks ugly and I have concerns about maintainability. We merged a first version of the structure, but I'm happy to change if we can come up with a better solution. Do you have suggestions on this?

I have a third less urgent question. The install-guide has it's own folder at the same level where these two projects have their 'doc' folder. I would assume other projects have the same or similar folder for the developer docs. Would that be reasonable/possible to have one main 'doc' folder for all the docs?

Thanks and Best Regards,
Ildikó

[1] https://review.openstack.org/#/c/330051/
[2] https://review.openstack.org/#/c/330048/


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

On 2016-06-28 14:55, Ildikó Váncsa wrote:
[...]
I have a third less urgent question. The install-guide has it's own folder at the same level where these two projects have their 'doc' folder. I would assume other projects have the same or similar folder for the developer docs. Would that be reasonable/possible to have one main 'doc' folder for all the docs?

I understand the sentiment. The install-guide is a separate book, as
Sean Dague called it nicely, which gets published to a different place,
integrated into the full Install Tutorial. If you make it part of the
developer documentation, it might integrate more nicely there but not in
the overall cross-project Install Tutorial. Developer documentation is a
separate book already and placing several books under doc will need even
further changes to make it clear what goes where and how to publish.

So, I think the top-level folder is the best place for this,

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-request@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

[openstack-dev] What's Up, Doc? 8 July

Hi everyone,

This week I'm pleased to report that the index page for the new Install Tutorials is up and running! We also had some lengthy discussions about the use of conditionalised formatting (with only), so there were a few meaty topics to go through in the meeting this week. It's also been way too long since we last did a core team review, so that happened this week. I'd also like to remind you that the CFP for Barcelona is only open until mid next week, so get your proposals in soon!

== Progress towards Newton ==

89 days to go!

Bugs closed so far: 256

I think 50 bugs in two weeks is something of a record! Thanks to all the bug smashers working hard this week :)

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
Feel free to add more detail and cross things off as they are achieved throughout the release.

The CFP for Barcelona is open now, until 13 July. If you want to brainstorm some documentation-related ideas, please get in touch!

== Speciality Team Reports ==

'''HA Guide: Bogdan Dobrelya'''
No report this week.

'''Install Guide: Lana Brindley'''
Index page is now up, needs some iteration to improve. Decided against using only for now (review after Newton), Manila patch to be updated. Next meeting: 19 July 0600 UTC

'''Networking Guide: Edgar Magana'''
No meeting this week. Keep trying to move documentation from other dispersed places to the networking guide.

'''Security Guide: Nathaniel Dillon'''
No report this week.

'''User Guides: Joseph Robinson'''
Adding the consistency notes to the work items wiki page. Team emails.

'''Ops Guide: Shilla Saebi'''
No report this week.

'''API Guide: Anne Gentle'''
Sign up on the etherpad to participate in a keystone Identity API sprint: https://etherpad.openstack.org/p/keystone-api-sprint
New patch this week to migrate the ceilometer Telemetry API docs, please review: https://review.openstack.org/334028 Thank you Khushbu!
Need another +2 from the swift team for their migration patch: https://review.openstack.org/#/c/312315/
Updated patch in the governance repo projects.yaml file to indicate both contributor docs URLs and API docs URLs: https://review.openstack.org/#/c/316396/ Consider a work in progress for URL completeness and accuracy, but please review for format.
Responding to input about API versions and release versions. See http://lists.openstack.org/pipermail/openstack-docs/2016-July/008818.html

'''Config/CLI Ref: Tomoyuki Kato'''
Closed many bugs.
Implementing common configuration sections for shared services and libraries.
Updated a few clients reference, and added solum client.

'''Training labs: Pranav Salunke, Roger Luethi'''
No report this week.

'''Training Guides: Matjaz Pancur'''
No report this week.

'''Hypervisor Tuning Guide: Blair Bethwaite
No report this week.

'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
Three out of the five personas have been created and are being reviewed.
https://review.openstack.org/#/c/326662/
The last two personas will be added to the change within the week.
It was suggested to add a checklist for developers to be able to identify the appropriate persona for their work.

== Core Team Review ==

The core team have completed their review for July, and we would like to welcome Joseph Robinson to the openstack-doc-core team.

Joseph has been leading the User Guides speciality team for some time now, and has been a docs-specs-core as part of that role. Welcome to the larger core team, Joseph, we're really pleased to have you aboard :)

== Site Stats ==

25% of our hits are coming from new (rather than returning) users.

== Doc team meeting ==

Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-07-06

Next meetings:
APAC: Wednesday 13 July, 00:30 UTC
US: Wednesday 20 July, 19:00 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#8_July_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] [Murano][user-guide][docs] Add section 'Murano applications guide' to the End User Guide

Hi, folks!

I'm working on user guide about developing and using custom Murano
applications. As far as I'm concerned End User Guide [1] would be a perfect
fit for this document. Mainly because, it demonstarates one more way to
regular cloud users, how they can consume services provided by OpenStack
cloud.

Looking through latest version of End User Guide, I surprisingly found that
there are no references to Murano project in it. So, I submitted this
patchset [2]. It suppose to be a placeholder to put Murano related user
guides in it. For the very begging, I just make reference on existed docs,
like it is done for Heat object templates [3] now. We already have been
working on more content for this section. So, what is proper way to move
forward? I see, some options here:

  • Submit a spec from this activity to docs-specs
  • Prepare whole Murano user guide and send it in a single patchset
  • Land initial patchset and continue work on providing more content

Personally, I'd prefer the latest option, but i'm not very familiar with
recognized flow. So, what do you think, folks?

Best Regards,
Serg Slipushenko

[1] http://docs.openstack.org/user-guide/
[2] https://review.openstack.org/#/c/340474/
[3] http://docs.openstack.org/user-guide/hot.html


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

[openstack-dev] What's Up, Doc? 15 July

Hi everyone,

CFP for the Barcelona Summit closed this week, so I've been caught up in the flurry of talk submissions. I hope you got yours in on time! We have more Installation Tutorials going up all the time, with Swift up and Designate now in progress. I'd also like to remind you all that we have instructions for creating your team's Install Tutorial in our Contributor Guide here: http://docs.openstack.org/contributor-guide/project-install-guide.html We'd love to get your feedback on that content!

== Progress towards Newton ==

82 days to go!

Bugs closed so far: 280

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
Feel free to add more detail and cross things off as they are achieved throughout the release.

The CFP for Barcelona is now closed. Best of luck to everyone who submitted a talk :)

== Speciality Team Reports ==

'''HA Guide: Bogdan Dobrelya'''
No report this week.

'''Install Tutorials: Lana Brindley'''
Continued to publish new guides, Swift is now up, Designate is on review. Submitted Summit talk on this topic. Don't miss our instructions for creating a new Install Tutorial: http://docs.openstack.org/contributor-guide/project-install-guide.html Next meeting: 19 July 0600 UTC

'''Networking Guide: Edgar Magana'''
No meeting this week.

'''Security Guide: Nathaniel Dillon'''
No report this week.

'''User Guides: Joseph Robinson'''
No report this week.

'''Ops Guide: Shilla Saebi'''
OpenStack ops guide reorg in progress & documented here: https://etherpad.openstack.org/p/ops-guide-reorg
Added enterprise docs troubleshooting information to the Ops Guide

'''API Guide: Anne Gentle'''
Keystone API sprint this week, details are here: https://etherpad.openstack.org/p/keystone-api-sprint Lance Bragstad is on FIRE!
Review these api-ref patchsets in progress: https://review.openstack.org/#/q/status:open+file:api-ref
Working on a plan for how to merge HTTP Status Code tables and Graham Hayes's patch to use the openstackdocstheme and Karen Bradshaw's overall API navigation in time for release, stay tuned.

'''Config/CLI Ref: Tomoyuki Kato'''
Got feedbacks from Dolph Matthews, thank you! Closed a few bugs. Updated some CLI reference.

'''Training labs: Pranav Salunke, Roger Luethi'''
Many minor improvements to training-labs library scripts
Finalizing PXE feature, still more work is required but the current patch should be in a state to be merged soon.
Finalizing parser POC to parse install-guides to BASH for testing install guides and also auto-creation of guest side scripts for training-labs

'''Training Guides: Matjaz Pancur'''
Removed unused images for Training guides, improvements on Getting Started (core and optional services, link updates).

'''Hypervisor Tuning Guide: Blair Bethwaite
No report this week.

'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
No report this week.

== Core Team Review ==

Regretfully, Diane Fleming is no longer a core team member. I'd like to thank Diane for all her contributions to our team. She's been a powerhouse core team member since well before I did my very first OpenStack patch, and I think it's fair to say that many of us wouldn't be here without Diane's support and guidance.

== Site Stats ==

The number of people browsing the site using Opera has dropped by 5% over the past 30 days, but nearly 20% more people are using Edge (which I'm told is the new Windows browser that's replacing IE). Oddly, IE users have increased slightly as well, though, by 7%. Are people abandoning their Macs?!

== Doc team meeting ==

Next meetings:

The APAC meeting was held this week (big thanks to Joseph for chairing that meeting in my absence!), you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-07-13

Next meetings:
US: Wednesday 20 July, 19:00 UTC
APAC: Wednesday 27 July, 00:30 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#15_July_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] What's Up, Doc? 22 July

Hi everyone,

As many of you would have noticed from the email onslaught, I've been working on some Launchpad housekeeping this week. The blueprints are all tidied up now, and I intend to start on the bug list next week, so keep those email filters handy ;)

I'd also like to point out the hard work Andreas has been putting in to evaluate moving our docs jobs to Ubuntu Xenial. If you notice any weirdness, please let Andreas know.

== Progress towards Newton ==

75 days to go!

Bugs closed so far: 315

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
Feel free to add more detail and cross things off as they are achieved throughout the release.

== Speciality Team Reports ==

'''HA Guide: Andrew Beekhof'''
Got drafted (pun intended)
Started figuring out the current status and direction

'''Install Tutorials: Lana Brindley'''
Next meeting: 2 August 0600 UTC

'''Networking Guide: Edgar Magana'''
No report this week.

'''Security Guide: Nathaniel Dillon'''
No report this week.

'''User Guides: Joseph Robinson'''
No report this week.

'''Ops Guide: Shilla Saebi, Darren Chan'''
Started a weekly Arch Guide working group meeting on Wednesday 20:00 UTC. Currently drafting the Design chapter and reusing existing content.

'''API Guide: Anne Gentle'''
Sent email to -dev and -docs list to determine next steps for releasing openstackdocstheme and os-api-ref sphinx extension so we can get the better theming output: http://lists.openstack.org/pipermail/openstack-dev/2016-July/099373.html
Released 1.4.0 of openstackdocstheme in preparation for August (hopefully) readiness of theme/extension for unifying API docs navigation.
Completed updated of governance/reference/projects.yaml to indicate contributor and api docs URLs. Found that three projects have not completed migration (trove, telemetry/ceilometer, ) and found that nn projects don't use the openstackdocstheme and os-api-ref extension and then won't be included in a unified navigation solution for all OpenStack APIs.

'''Config/CLI Ref: Tomoyuki Kato'''
Adding Clustering service configuration options. Fixed some bugs. Updated a few CLI reference. Added python-watcherclient.

'''Training labs: Pranav Salunke, Roger Luethi'''
No report this week.

'''Training Guides: Matjaz Pancur'''
No report this week.

'''Hypervisor Tuning Guide: Blair Bethwaite
No report this week.

'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
All five personas are up for review on Gerrit. https://review.openstack.org/#/c/326662/
Further improvements are planned for after the basic information is merged.

== HA Guide Speciality Team Update ==

Bogdan Dobrelya is stepping down from leading the HA Guide Speciality Team, and I would like to thank him for his hard work. I'd like to welcome Andrew Beekhof to the role, and wish him all the best. If you're interesting in helping out on the HA Guide, please let Andrew or me know and we'll get you started.

== Site Stats ==

While 70% of our site traffic comes through Google, just under 5% comes through Baidu, beating Bing on just 1.45%.

== Doc team meeting ==

Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-07-20

Next meetings:
APAC: Wednesday 27 July, 00:30 UTC
US: Wednesday 3 August, 19:00 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#22_July_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] What's Up, Doc? 29 July

Hi everyone,

A fairly quiet week this week, as I've been gradually working my way through old bugs. We're now only ten weeks out from release, so I've also been trying to tidy up some loose ends around the Contributor Guide. We have a couple of specs out for review right now, so if you're looking for some docs work to pick up, try checking these out: https://review.openstack.org/#/q/status:open+project:openstack/docs-specs,n,z

== Progress towards Newton ==

68 days to go!

Bugs closed so far: 339

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
Feel free to add more detail and cross things off as they are achieved throughout the release.

== Speciality Team Reports ==

'''HA Guide: Andrew Beekhof'''
Informal discussions about appropriate contents and structure

'''Install Tutorials: Lana Brindley'''
Next meeting: 2 August 0600 UTC

'''Networking Guide: Edgar Magana'''
Guide re-organization patch has been merged: https://review.openstack.org/#/c/345110/

'''Security Guide: Nathaniel Dillon'''
Performing full read-through and bug hunt
Opened 5 new bugs
Currently looking at Neutron chapter
Incoming addition on rate-limiting and anti-DDoS (framework merged tonight (thanks Kato!) and additional details coming)

'''User Guides: Joseph Robinson'''
No report this week.

'''Ops Guide: Shilla Saebi, Darren Chan'''
Weekly Arch Guide working group meeting on Wednesday 20:00 UTC in progress.
Currently drafting the Design chapter and reusing existing content.
Working on getting more enterprise docs uploaded and pushed upstream for ops guide

'''API Guide: Anne Gentle'''
First App tutorial for the Shade SDK now moving out of draft state. Way to go Marcela Bonell and infra people who make this SDK possible.
Thank you to Kato Tomoyuki for deletions of the Image and Networking WADL files in api-site. This ongoing dedication and cleanup is super valuable and much appreciated.

'''Config/CLI Ref: Tomoyuki Kato'''
Reflecting comments from Stackers. Closed a few bugs for Configuration Reference. Working on the common configurations.

'''Training labs: Pranav Salunke, Roger Luethi'''
No report this week.

'''Training Guides: Matjaz Pancur'''
No report this week.

'''Hypervisor Tuning Guide: Blair Bethwaite
No report this week.

'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
No report this week.

== Site Stats ==

Just under 55% of our mobile visitors are using an Android operating system to access the site, while just under 40% of our mobile visitors are using iOS. A statistically insignificant 0.07% are still using their Blackberries ...

== Doc team meeting ==

Next meetings:

The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-07-27

Next meetings:
US: Wednesday 3 August, 19:00 UTC
APAC: Wednesday 10 August, 00:30 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#29_July_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] What's Up, Doc? 12 August

Hi everyone,

I have been struck down with flu yet again this week, so a quiet one from me (I'll be glad when winter is over, let me tell you!). Anne, however, has been kicking it out of the park with her work on the API docs; I suggest you take a look at the update she sent to the mailing lists the other day to catch up: http://lists.openstack.org/pipermail/openstack-dev/2016-August/101380.html

== Progress towards Newton ==

54 days to go!

Bugs closed so far: 365

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
Feel free to add more detail and cross things off as they are achieved throughout the release.

== Speciality Team Reports ==

'''HA Guide: Andrew Beekhof'''
No report this week.

'''Install Tutorials: Lana Brindley'''
Next meeting: 16 August 0600UTC

'''Networking Guide: Edgar Magana'''
No report this week.

'''Security Guide: Nathaniel Dillon'''
Bug hunt continued, all contributions are welcome, grammatical and technical alike! Focusing on the last half of the SecurityGuide, and the 'freshness' of code examples
Threat analysis documentation and templates added

'''User Guides: Joseph Robinson'''
The Consistency and Editing patch is ready to merge, and just needs more reviews https://review.openstack.org/#/c/347641/ .
Some pages in the User Guides are resulting in 404s (dashboard manage shares for example), and this bug is tracking the changes
https://bugs.launchpad.net/openstack-manuals/+bug/1611792
Thanks to Maria for taking on the file name changes to the User Guide, and Anne for also patching the Admin Guide file names!

'''Ops Guide: Shilla Saebi, Darren Chan'''
Working on storage, networking, and compute sections in the Arch Guide.
Arch Guide working group proposed a series of short sprints, working in pairs as SME/writer. Dates TBD
Waiting on enterprise ops documentation to migrate to the Ops Guide.

'''API Guide: Anne Gentle'''
Ceilometer migrated content has landed! \o/ https://review.openstack.org/334028 Many thanks to Khushbu Parakh for sticking with it, and to Julien Danjou and Gordon Chung for accepting the (rather outdated) migrated content and taking responsiblity for it from now on.
Working on a template for http-status.yaml file that teams can use for new pretty HTTP Status code tables that just landed last week. https://review.openstack.org/#/c/351835/
Ever closer to landing the API reference navigation. https://review.openstack.org/#/c/329508/
Refer to status report on -dev and -docs mailing lists: http://lists.openstack.org/pipermail/openstack-dev/2016-August/101380.html

'''Config/CLI Ref: Tomoyuki Kato'''
Closed a few bugs with mitaka backport.

'''Training labs: Pranav Salunke, Roger Luethi'''
No report this week.

'''Training Guides: Matjaz Pancur'''
Updating Upstream training for the next OpenStack Summit (https://etherpad.openstack.org/p/upstream-university-improvements)
Next meeting: Monday 15 August 1700 UTC in #openstack-meeting

'''Hypervisor Tuning Guide: Blair Bethwaite
No report this week.

'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
No report this week.

== Site Stats ==

This week, 385 visitors came to the docs site from Stack Overflow, 423 visitors came via searching on duckduckgo, and 508 came from ask.openstack.org.

== Doc team meeting ==

Next meetings:

The APAC meeting failed to make quorum this week, but thanks to Darren for trying anyway :)

Next meetings:
US: Wednesday 17 August, 19:00 UTC
APAC: Wednesday 24 August, 00:30 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#12_August_2016
--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] What's Up, Doc? 19 August

Hi everyone,

Watch out, Install Guide testing season is about to begin! If you're a package maintainer, cross-project liaison, or just a helpful testing regular, look out for an email from me real soon now! In the meantime, keep hitting those bugs, and letting us know if you spot any problems in the guide.

== Progress towards Newton ==

47 days to go!

Bugs closed so far: 371

Newton deliverables: https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables
Feel free to add more detail and cross things off as they are achieved throughout the release.

== Speciality Team Reports ==

'''HA Guide: Andrew Beekhof'''
Some reviews, nothing interesting

'''Install Tutorials: Lana Brindley'''
Core Guide testing to kick off Real Soon Now (tm). Next meeting: 30 August 0600UTC.

'''Networking Guide: Edgar Magana'''
No report this week.

'''Security Guide: Nathaniel Dillon'''
No report this week.

'''User Guides: Joseph Robinson'''
No report this week.

'''Ops Guide: Shilla Saebi, Darren Chan'''
Reorganized monitoring content in the Ops Guide
Migrating ops, legal, and security content in the Arch Guide
Working on use cases chapter and design chapter in the Arch Guide

'''API Guide: Anne Gentle'''
No report this week.

'''Config/CLI Ref: Tomoyuki Kato'''
A few cleanups are under going. Updated some client references.

'''Training labs: Pranav Salunke, Roger Luethi'''
No report this week.

'''Training Guides: Matjaz Pancur'''
No report this week.

'''Hypervisor Tuning Guide: Blair Bethwaite
No report this week.

'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
No report this week.

== Site Stats ==

Just under 90,000 sessions on the docs site this week.

== Doc team meeting ==

Next meetings:

The US meeting failed to make quorum this week. We're seeing this a lot recently, is there still a need for a regular docs meeting?

Next meetings:
APAC: Wednesday 24 August, 00:30 UTC
US: Wednesday 31 August, 19:00 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#19_August_2016
--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

On 19/08/16 14:59, Lana Brindley wrote:

== Doc team meeting ==

Next meetings:

The US meeting failed to make quorum this week. We're seeing this a lot recently, is there still a need for a regular docs meeting?

A correction: US meeting did go ahead this week, minutes are here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-08-17

Please excuse me while I try to work out how to use eavesdrop.

Next meetings:
APAC: Wednesday 24 August, 00:30 UTC
US: Wednesday 31 August, 19:00 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#19_August_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] What's Up, Doc? 26 August

Hi everyone,

This week marks six weeks left to the Newton release, so I've been busy getting everything prepared. We're now ready to start testing the core Installation Tutorial, so check out the wiki and get signed up: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting#Testers We've also selected two new release managers to assist with this release, please welcome Olena and Alex! More on those topics in this newsletter.

== Progress towards Newton ==

40 days to go!

Bugs closed so far: 387

Release planning: https://etherpad.openstack.org/p/NewtonRelease

== Release Managers ==

There was an overwhelming response to my request for release managers, which was very cool! The first two responders were Olena Logvinova ologvinova@mirantis.com and Alexandra Settle alexandra.settle@RACKSPACE.COM, so please welcome them to the release team. Their main role during this process is to make sure that all the tasks we have to complete get done accurately and on schedule. It's an important job, and we're really glad to have you both on board.

== Install Tutorial Testing ==

Install Tutorial testing is just about ready to kick off. If you're interested in helping, make sure you've added your name on to the list on our testing wiki page: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting (if you don't have wiki access, just email me directly and I'll add you in).

Thanks to our package maintainers, we now have b2 pre-release packages ready for Ubuntu and Debian, so those are ready to be tested.

== Docs Tools ==

I'm very pleased to announce that we have now removed DocBook from our build tools. The end of an era! Thanks to Anne, Andreas, and David Cramer for keeping this project alive for so long, and eventually seeing it come to fruition.

Version 1.5.0 of openstackdoccstheme was released this week.

In other tools news, there are plans afoot to move developer.openstack.org and docs.openstack.org away from Rackspace Cloudsites, and on to pages that OpenStack Infra control. This has been on the proverbial backburner for a long time, but the Infra team is now in a position to make it happen. You can read and comment on the Infra spec here: https://review.openstack.org/#/c/276482/

== Speciality Team Reports ==

'''HA Guide: Andrew Beekhof'''
No report this week.

'''Install Tutorials: Lana Brindley'''
Core Guide testing is underway! Check out progress and sign up here: https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting Next meeting: 30 August 0600UTC.

'''Networking Guide: Edgar Magana'''
Attending the OpenStack East in NYC. No report this week.

'''Security Guide: Nathaniel Dillon'''
No report this week.

'''User Guides: Joseph Robinson'''
No report this week.

'''Ops Guide: Shilla Saebi, Darren Chan'''
No report this week.

'''API Guide: Anne Gentle'''
Releasing openstackdocstheme with new sidebar and integration with os-api-ref Sphinx Extension. Many thanks to Karen Bradshaw, Sean Dague, Graham Hayes, Andreas Jaeger (and anyone I may have missed!) for their tireless efforts on this release. WOW.

'''Config/CLI Ref: Tomoyuki Kato'''
Merged some patches, updated a few CLI reference, nothing special.

'''Training labs: Pranav Salunke, Roger Luethi'''
Some minor changes, backports of features.
The parser is almost done. https://github.com/dguitarbite/rst2bash
Updated the openstack-manuals, install-guides with the new syntax which is parser friendly. I should start sending the required patches to manuals repo. soon after finalizing the syntax.. https://github.com/dguitarbite/openstack-manuals/commit/c9e7e1bb2c7269f02a757768dd2dd309fa2233ac

'''Training Guides: Matjaz Pancur'''
Upstream training improvement (https://etherpad.openstack.org/p/upstream-university-improvements). Please consider participating in the Remote content sprint (proposed timeframe: first half of September, see etherpad for details).

'''Hypervisor Tuning Guide: Blair Bethwaite
No report this week.

'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
No report this week.

== Site Stats ==

Keystone and Ceph are this week's most popular search terms.

== Doc team meeting ==

Next meetings:

The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-08-24

Next meetings:
US: Wednesday 31 August, 19:00 UTC
APAC: Wednesday 7 September, 00:30 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#26_August_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] [api] [all] New landing page for API docs collection

Hi all,
I've put together a solution for your review to replace
developer.openstack.org/api-ref.html with a new landing page. My idea is to
repurpose this page: http://developer.openstack.org/api-guide/quick-start/
as a collection point for all the API information. Once this lands, I will
redirect developer.openstack.org/api-ref.html to this new page.

Review is here:
https://review.openstack.org/#/c/361480/

Some projects are not in the list due to not having an API reference page
that is published to developer.openstack.org. Top of mind are cinder and
telemetry as you're super close and only need a little bit more work to get
over the line. I'm happy to get you where you want to be, just let me know
what you need.

Let me know your thoughts on how to get all the APIs in a single page as a
good starting point for consumers.
Thanks,
Anne

--
Anne Gentle
www.justwriteclick.com


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

[openstack-dev] What's Up, Doc? 2 September

Hi everyone,

We have five weeks left until the Newton release goes out, so this week has been all about getting started on testing the Install Guide. We now have beta releases for all our distros, so thanks to our lovely package maintainers for getting back to me so quickly! We can still use more testers, though, all you need to do is sign up on the wiki page and start testing: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting

This week Andreas, Brian, Olga, and I will be meeting with our new release managers Olena and Alex, to make sure they're up to speed. Don't forget that you can contact any of us (or just send mail to the docs mailing list) if you have any questions about the Newton docs release.

== Progress towards Newton ==

33 days to go!

Bugs closed so far: 407

Release managers: Olena Logvinova and Alexandra Settle

Install Guide testing is being tracked here: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting

== The Road to Barcelona ==

== Docs Tools ==

There is a lot of cleanup happening on the docs site right now, so you might see some old and unloved content disappear. If you notice anything strange, please let Andreas or the docs mailing list know so we can get it straightened out.

== Speciality Team Reports ==

'''HA Guide: Andrew Beekhof'''
No report this week.

'''Install Tutorials: Lana Brindley'''
Core Guide testing is underway! Check out progress and sign up here: https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting Next meeting: 13 September August 0600UTC.

'''Networking Guide: Edgar Magana'''
No report this week.

'''Security Guide: Nathaniel Dillon'''
No report this week.

'''User Guides: Joseph Robinson'''
No report this week.

'''Ops Guide: Shilla Saebi, Darren Chan'''
No meeting last week in light of the ops mid cycle and OpenStack East conference
Updating use cases chapter in Arch Guide
Looking for more enterprise troubleshooting docs to push upstream for the ops guide

'''API Guide: Anne Gentle'''
New landing page for a collection of all API Reference docs and Guides in one place: https://review.openstack.org/#/c/361480/
Improvements to the sidebar link collection: https://review.openstack.org/#/c/362436/

'''Config/CLI Ref: Tomoyuki Kato'''
Updated some CLI reference. Closed some bugs for Config Reference.

'''Training labs: Pranav Salunke, Roger Luethi'''
No report this week.

'''Training Guides: Matjaz Pancur'''
No report this week.

'''Hypervisor Tuning Guide: Blair Bethwaite
No report this week.

'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
No report this week.

== Site Stats ==

For the month of August, we had a 6% increase in traffic over July.

== Doc team meeting ==

Next meetings:

The US meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-08-31

Next meetings:
APAC: Wednesday 7 September, 00:30 UTC
US: Wednesday 14 September, 19:00 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#2_September_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] What's Up, Doc? 9 September

Hi everyone,

Only four weeks to go until Newton! Andreas, Brian, Olga, and I met with our new release managers Olena and Alex a few days ago, and we're all ready and waiting with bated breath to get started on the release. Don't forget that you can contact any of us (or just send mail to the docs mailing list) if you have any questions about the Newton docs release.

This week, I've also done a core team review, and we bid farewell to two core team members. More on that in this newsletter.

== Progress towards Newton ==

26 days to go!

Bugs closed so far: 428

Release managers: Olena Logvinova and Alexandra Settle

Release tasks are being tracked here: https://etherpad.openstack.org/p/NewtonRelease

Install Guide testing is being tracked here: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting

== The Road to Barcelona ==

Looking a little further forward, Foundation have now announced that the first Project Team Gathering (PTG) will be held in Atlanta, US, on Feb 20-24: http://www.openstack.org/ptg

== Core Team Review ==

The core team have completed their review for August, and I'm a bit sad to announce that both Atsushi Sakai and Gauvain Pocontek are no longer core team members.

Gauvain has been committing to OpenStack manuals since well before my time, and has been an invaluable resource for many people (including myself!) over the years. He is currently working on some new projects, but we hope to still see him around from time to time.

Atsushi-san joined the core team last year, and during that time has proven an extremely effective reviewer. He is still very busy on OpenStack, with an increased focus on cross-project tasks, so we will be sure to still see him around. I wish you well on your endeavours!

I thank you both for your commitment to being core team members, and for all your contributions. We are better because of your effort.

== Speciality Team Reports ==

'''HA Guide: Andrew Beekhof'''
Organizing a HA meetup at summit
Intention is get an update plan finalized shortly

'''Install Tutorials: Lana Brindley'''
Core Guide testing is underway! Check out progress and sign up here: https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting Next meeting: 13 September August 0600UTC.

'''Networking Guide: Edgar Magana'''
No report this week.

'''Security Guide: Nathaniel Dillon'''
No report this week.

'''User Guides: Joseph Robinson'''
No report this week.

'''Ops Guide: Shilla Saebi, Darren Chan'''
No report this week.

'''API Guide: Anne Gentle'''
Working on an article for Super User describing the switchover in API guide sources to project repos and the new navigation.

'''Config/CLI Ref: Tomoyuki Kato'''
Consolidating the OSC command reference into the OSC specific doc.

'''Training labs: Pranav Salunke, Roger Luethi'''
No report this week.

'''Training Guides: Matjaz Pancur'''
Finished first day of our virtual sprint series (6 Sep): Common items: https://etherpad.openstack.org/p/upstream-uni-common-items (coordinated by Ildiko Vancsa, ildikov), Code contribution: https://etherpad.openstack.org/p/upstream-uni-code-contribution (coordinated by Kendall Nelson, diablo_rojo)
Next virtual sprint dates: 12,13 and 16 September (https://wiki.openstack.org/wiki/VirtualSprints#Upstream_training_Sprint)

'''Hypervisor Tuning Guide: Blair Bethwaite
No report this week.

'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
No report this week.

== Doc team meeting ==

Next meetings:

The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-09-07

Next meetings:
US: Wednesday 14 September, 19:00 UTC
APAC: Wednesday 21 September, 00:30 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#9_September_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

2016-09-09 12:43 GMT+09:00 Lana Brindley openstack@lanabrindley.com:

Hi everyone,

Only four weeks to go until Newton! Andreas, Brian, Olga, and I met with our new release managers Olena and Alex a few days ago, and we're all ready and waiting with bated breath to get started on the release. Don't forget that you can contact any of us (or just send mail to the docs mailing list) if you have any questions about the Newton docs release.

This week, I've also done a core team review, and we bid farewell to two core team members. More on that in this newsletter.

== Progress towards Newton ==

26 days to go!

Bugs closed so far: 428

Release managers: Olena Logvinova and Alexandra Settle

Release tasks are being tracked here: https://etherpad.openstack.org/p/NewtonRelease

Install Guide testing is being tracked here: https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting

== The Road to Barcelona ==

Looking a little further forward, Foundation have now announced that the first Project Team Gathering (PTG) will be held in Atlanta, US, on Feb 20-24: http://www.openstack.org/ptg

== Core Team Review ==

The core team have completed their review for August, and I'm a bit sad to announce that both Atsushi Sakai and Gauvain Pocontek are no longer core team members.

Gauvain has been committing to OpenStack manuals since well before my time, and has been an invaluable resource for many people (including myself!) over the years. He is currently working on some new projects, but we hope to still see him around from time to time.

Atsushi-san joined the core team last year, and during that time has proven an extremely effective reviewer. He is still very busy on OpenStack, with an increased focus on cross-project tasks, so we will be sure to still see him around. I wish you well on your endeavours!

I thank you both for your commitment to being core team members, and for all your contributions. We are better because of your effort.

== Speciality Team Reports ==

'''HA Guide: Andrew Beekhof'''
Organizing a HA meetup at summit
Intention is get an update plan finalized shortly

'''Install Tutorials: Lana Brindley'''
Core Guide testing is underway! Check out progress and sign up here: https://wiki.openstack.org/wiki/Documentation/MitakaDocTesting Next meeting: 13 September August 0600UTC.

I think the correct URL of the wiki page is
https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting .

'''Networking Guide: Edgar Magana'''
No report this week.

'''Security Guide: Nathaniel Dillon'''
No report this week.

'''User Guides: Joseph Robinson'''
No report this week.

'''Ops Guide: Shilla Saebi, Darren Chan'''
No report this week.

'''API Guide: Anne Gentle'''
Working on an article for Super User describing the switchover in API guide sources to project repos and the new navigation.

'''Config/CLI Ref: Tomoyuki Kato'''
Consolidating the OSC command reference into the OSC specific doc.

'''Training labs: Pranav Salunke, Roger Luethi'''
No report this week.

'''Training Guides: Matjaz Pancur'''
Finished first day of our virtual sprint series (6 Sep): Common items: https://etherpad.openstack.org/p/upstream-uni-common-items (coordinated by Ildiko Vancsa, ildikov), Code contribution: https://etherpad.openstack.org/p/upstream-uni-code-contribution (coordinated by Kendall Nelson, diablo_rojo)
Next virtual sprint dates: 12,13 and 16 September (https://wiki.openstack.org/wiki/VirtualSprints#Upstream_training_Sprint)

'''Hypervisor Tuning Guide: Blair Bethwaite
No report this week.

'''UX/UI Guidelines: Michael Tullis, Rodrigo Caballero'''
No report this week.

== Doc team meeting ==

Next meetings:

The APAC meeting was held this week, you can read the minutes here: https://wiki.openstack.org/wiki/Documentation/MeetingLogs#2016-09-07

Next meetings:
US: Wednesday 14 September, 19:00 UTC
APAC: Wednesday 21 September, 00:30 UTC

Please go ahead and add any agenda items to the meeting page here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#9_September_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


OpenStack-I18n mailing list
OpenStack-I18n@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-i18n


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

[openstack-dev] [Docs][PTL] PTL Candidacy for Docs

Hi everyone,

I am seeking re-election as Documentation PTL for Ocata. I have been the docs
PTL since Liberty, and together we've converted the entire docs suite to RST,
decommissioned the old DocBook infrastructure, and fundamentally changed the
way projects document their installation procedures. Ocata is a short cycle,
so I want to take this opportunity to focus inwards on our community. I would
love your support to do this in Ocata.

In Mitaka we embarked on an ambitious plan to convert our entire documentation
suite to RST, and in Newton we put the finishing touches to that project by
decommissioning the old DocBook infrastructure. With that long-term project
complete, we have gone on to develop a new publication model that allows
projects to write documentation in their own repos, and publish seamlessly to
the docs.openstack.org front page. This project goes live for the Installation
Guide and API docs with Newton, and means our documentation efforts are
continuing to scale out to represent a much greater proportion of products,
contributors, operators, and users. I would like to continue this work in
Ocata by evaluating the success of the project, and identifying more efficient
and productive pathways for users to find and use the information provided by
the docs team. I also want to explore more innovative ways for the
documentation team to work together, including a review of the speciality team
and release processes. I want to continue to foster collaboration between
developers and writers to provide the best possible documentation for the
entire OpenStack community.

During Newton, in addition to the Installation Guide changes, we focussed on
streamlining our processes, clarifying the way we operate, consolidating
guides, and general editing and tidying up. I want to continue this work in
Ocata to provide a better documentation experience for everyone: writers,
developers, operators, and users.

In the Liberty release cycle, we closed just over 600 bugs, and in Mitaka we
closed 645. With the rate of new bug creation rapidly dropping thanks to
procedural changes we made in Mitaka, our consistent effort has really paid
down a lot of our technical debt. For Newton so far, we've closed well over
400 bugs, and we have only 327 bugs in the queue as I write this, so this
positive trend continues.

I'll be making the trek to Barcelona soon for the Ocata summit, to catch up
with old friends and hopefully meet some of our newest contributors. Please be
sure to stop for a chat if you see me around. I'm also excited about the new
Project Team Gathering coming up in February; I think this will be a great
opportunity for cross-project teams like docs.

I'd love to have your support for the PTL role for Ocata. I'm looking forward
to continuing to grow the documentation team and to keep working on these
incremental improvements to content delivery.

Thanks,
Lana (@loquacities)

https://review.openstack.org/#/c/370477/

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

Re: [openstack-dev] [OpenStack-docs] Admin guide in-tree?

(Adding the dev list to cc, as I think this conversation deserves a wider audience)

Thanks for this feedback. I'm really glad that the new Install Guide model is working out well for people!

Since our new Install Guides have only just been published, at this stage I'm intending to gather some data on how projects and users are using the project-specific Install Guides during the next cycle. I'm also intending to spend some time in the Ocata cycle on improving that index page. It's pretty ugly right now, and I think there's some serious UX improvements to be done. Since Ocata is a short cycle, I'm also conscious of how much the docs team might realistically be able to achieve.

All that said, you are certainly not the first to ask if this model can be extended! I think it's something that the docs community would like to see, and it seems as though it has broad support amongst developers and projects as well. So, in short, I think this is a thing that will happen, but probably not in Ocata. I'm tentatively willing to tell you that Pike is a possibility though ;)

Lana

On 07/10/16 12:43, Steve Martinelli wrote:

FWIW, the keystone team would also be interested in this model

On Thu, Oct 6, 2016 at 11:40 AM, Jay Faulkner <jay@jvf.cc jay@jvf.cc> wrote:

Hi all,

For those of you who don't know me, I'm Jay Faulkner and I work on Ironic as the Docs liaison as one of my hats.

Ironic launched our install-guide right after newton closed, and backported it, thanks to the changes to make the install-guide available in tree. We're a huge fan of this model, and I'm curious if there's any plans to make this happen for the admin-guide. If not, can someone help me understand the scope of work, presuming it's something that the docs group is interested in.

If we can get the technical infrastructure in place to do admin-guide in tree, I'd expect Ironic to quickly adopt it, like we did for the install guide.

Thanks,
Jay Faulkner
OSIC


_______________________________________________
OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org <mailto:OpenStack-docs@lists.openstack.org>
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs>


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

I'm not necessarily just asking for it to be done -- I'm curious what the scope of work is because I'm potentially willing to help (and find folks to help) get it done sooner. If the docs team does not support the admin guide in-tree until Pike, It'll be Q or later before other projects can utilize it. That's over a year from today, and I'd rather not have to wait that long to get a better admin guide up for Ironic.

Thanks,
Jay Faulkner
OSIC

On Oct 6, 2016, at 8:04 PM, Lana Brindley openstack@lanabrindley.com wrote:

(Adding the dev list to cc, as I think this conversation deserves a wider audience)

Thanks for this feedback. I'm really glad that the new Install Guide model is working out well for people!

Since our new Install Guides have only just been published, at this stage I'm intending to gather some data on how projects and users are using the project-specific Install Guides during the next cycle. I'm also intending to spend some time in the Ocata cycle on improving that index page. It's pretty ugly right now, and I think there's some serious UX improvements to be done. Since Ocata is a short cycle, I'm also conscious of how much the docs team might realistically be able to achieve.

All that said, you are certainly not the first to ask if this model can be extended! I think it's something that the docs community would like to see, and it seems as though it has broad support amongst developers and projects as well. So, in short, I think this is a thing that will happen, but probably not in Ocata. I'm tentatively willing to tell you that Pike is a possibility though ;)

Lana

On 07/10/16 12:43, Steve Martinelli wrote:

FWIW, the keystone team would also be interested in this model

On Thu, Oct 6, 2016 at 11:40 AM, Jay Faulkner <jay@jvf.cc jay@jvf.cc> wrote:

Hi all,

For those of you who don't know me, I'm Jay Faulkner and I work on Ironic as the Docs liaison as one of my hats.

Ironic launched our install-guide right after newton closed, and backported it, thanks to the changes to make the install-guide available in tree. We're a huge fan of this model, and I'm curious if there's any plans to make this happen for the admin-guide. If not, can someone help me understand the scope of work, presuming it's something that the docs group is interested in.

If we can get the technical infrastructure in place to do admin-guide in tree, I'd expect Ironic to quickly adopt it, like we did for the install guide.

Thanks,
Jay Faulkner
OSIC


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


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

[openstack-dev] What's Up, Doc? Newton Edition!

Hi everyone,

First of all, Newton docs are live on http://docs.openstack.org/ \o/

Thank you to our release managers, Olena and Alex, who have put in the hard yards over the past few weeks to get us in good shape. Thanks also to Andreas and Kato-san, for everything that they do, and to our speciality team leads and cross project liaisons. And thanks to Christian and Matt for the last minute assistance.

Of course, every release belongs to all of you who have written, tested, reviewed, updated, triaged, and edited over the last six months. Well done on another successful release :)

Don't forget that you can still use "#success" before a message in any OpenStack IRC channel to call out wins, they are gathered here: https://wiki.openstack.org/wiki/Successes

== Progress towards Newton ==

Newton has been released unto the world. We fixed 479 bugs this cycle, and completed 15 blueprints.

We'll begin planning for Ocata over the next couple of weeks, culminating in the Barcelona Summit 25-28 October, where we'll develop our Ocata deliverables list. Stay tuned!

== The Road to Barcelona ==

Our docs schedule is now available here: https://www.openstack.org/summit/barcelona-2016/summit-schedule/global-search?t=Documentation%3A

We are also hoping to have a docs session in the Ops track. I'll get back to you with more information on that as soon as I have it.

I've requested a docs track at the PTG in Atlanta next February, which will be used for Ocata review and Pike planning. Please let me know if you intend to participate.

== Core Team Reviews ==

Just a quick note that we won't be holding a core team review in November, as it conflicts with Summit. We'll resume these in December for the Ocata cycle.

== Doc team meeting ==

We will take a short break and resume the normal meeting schedule after Summit. In the meantime, you can catch most of us in #openstack-doc in a variety of timezones, so feel free to drop in and ask questions any time.

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#7_October_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] [Docs] Changes to docs speciality teams, meetings, and reporting

Hi everyone,

There was a long-running and wide-ranging conversation during Summit about community engagement in the docs team, most formally at the 'Social Things' session[1], and culminating in the 'Ocata Planning' session[2] on the last day. I suggest you read those etherpads if you weren't at the sessions. This was a major part of my PTL candidacy platform for Ocata, and I'm excited that we had so much productive conversation, complete with some action items that we can implement immediately.

First of all, we have seen a drop off in both docs mailing list traffic and docs meeting conversation over the past twelve months or so, even though contributions have remained steady (for the openstack-manuals repo). This is attributed partially to a much-improved Contributor Guide (meaning we spend less time on answering the same questions over and over), and but it's also apparently because conversation is splintering off into speciality team groups, rather than happening in the wider context of the docs group as a whole.

So, while speciality teams are definitely valued and important, especially when it comes to directing and completing specific work items, we have come up with a few smaller changes we can make to try and improve our sense of community:

  • Speciality team meetings are now going to be restricted to once per month, or on an as-needed basis.
  • The docs meeting will change to a single Euro/APAC timed meeting, every second week, probably around 2100 UTC (to be confirmed).
  • I will no longer be asking speciality team leads for a written report for the newsletter. Instead, please attend the docs meeting and report there. If you are not able to attend, you will have the option to provide a written report ahead of time to be presented by a proxy.
  • The newsletter will go to every second week, timed to be after the docs meeting, and will contain speciality team reports and other updates from that meeting.

I would like your feedback on these changes, especially if you didn't get a chance to participate in the conversation at Summit.

I will be implementing these changes over the next week or so, and there will be further opportunity for you to express your opinion on these changes as we go.

Lana

1: https://etherpad.openstack.org/p/BCN-Docs-Social
2: https://etherpad.openstack.org/p/BCN-Docs-OcataPlanningWG

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

We now have a new docs meeting time, every second Thursday 2100, starting next week, on 18 November.

See you there!

L

On 04/11/16 11:23, Lana Brindley wrote:
Hi everyone,

There was a long-running and wide-ranging conversation during Summit about community engagement in the docs team, most formally at the 'Social Things' session[1], and culminating in the 'Ocata Planning' session[2] on the last day. I suggest you read those etherpads if you weren't at the sessions. This was a major part of my PTL candidacy platform for Ocata, and I'm excited that we had so much productive conversation, complete with some action items that we can implement immediately.

First of all, we have seen a drop off in both docs mailing list traffic and docs meeting conversation over the past twelve months or so, even though contributions have remained steady (for the openstack-manuals repo). This is attributed partially to a much-improved Contributor Guide (meaning we spend less time on answering the same questions over and over), and but it's also apparently because conversation is splintering off into speciality team groups, rather than happening in the wider context of the docs group as a whole.

So, while speciality teams are definitely valued and important, especially when it comes to directing and completing specific work items, we have come up with a few smaller changes we can make to try and improve our sense of community:

  • Speciality team meetings are now going to be restricted to once per month, or on an as-needed basis.
  • The docs meeting will change to a single Euro/APAC timed meeting, every second week, probably around 2100 UTC (to be confirmed).
  • I will no longer be asking speciality team leads for a written report for the newsletter. Instead, please attend the docs meeting and report there. If you are not able to attend, you will have the option to provide a written report ahead of time to be presented by a proxy.
  • The newsletter will go to every second week, timed to be after the docs meeting, and will contain speciality team reports and other updates from that meeting.

I would like your feedback on these changes, especially if you didn't get a chance to participate in the conversation at Summit.

I will be implementing these changes over the next week or so, and there will be further opportunity for you to express your opinion on these changes as we go.

Lana

1: https://etherpad.openstack.org/p/BCN-Docs-Social
2: https://etherpad.openstack.org/p/BCN-Docs-OcataPlanningWG

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] [OpenStack-docs] [openstack deployment] Adding deployment guides to docs.o.o

Hi everyone,

A discussion was held in the OpenStack manuals social track at the Barcelona summit and we agreed to start including deployment projects, with appropriate installation guide(s), into the docs.o.ohttp://docs.openstack.org/ site. Similar to what we have done with the Installation Tutorials.

After working heavily with the OpenStack-Ansible team over the last few cycles, I have worked to ensure their Installation Guide is of the same standard as our manuals docs – following the Contributor guide and OpenStack manuals formatting – and have proposed their guide as the guinea pig for this transition.

At the moment, we are working on the best way to publish. Experimenting with the OpenStack-Ansible guide, we have the following patches in motion:

· https://review.openstack.org/391499 (Deployment gate jobs)

· https://review.openstack.org/391486 (Putting the OpenStack-Ansible guide into the manuals cookie cutter)

All deployment projects will have the opportunity to include their individual installation guides – to be called, “Deployment Guides” (this is open for discussion if others have better ideas).

If anyone is able to help with getting these patches merged to forge an easy pathway for other deployment guides, that would be amazing. I am looking to get some help in identifying what is the best path to publish to, and help with the index files.

If any of the deployment projects are interested in getting involved, let us know and we can work together to make this transition ☺

Thanks,

Alexandra Settle

Information Developer II
Rackspace Private Cloud Powered By OpenStack
London, United Kingdom


Rackspace Limited is a company registered in England & Wales (company registered number 03897010) whose registered office is at 5 Millington Road, Hyde Park Hayes, Middlesex UB3 4AZ. Rackspace Limited privacy policy can be viewed at www.rackspace.co.uk/legal/privacy-policy - This e-mail message may contain confidential or privileged information intended for the recipient. Any dissemination, distribution or copying of the enclosed material is prohibited. If you receive this transmission in error, please notify us immediately by e-mail at abuse@rackspace.com and delete the original message. Your cooperation is appreciated.

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

On 11/10/2016 05:32 AM, Gyorgy Szombathelyi wrote:

Hi everyone,

Hi Alexandra,

If any of the deployment projects are interested in getting involved, let us
know and we can work together to make this transition :)

We have an ansible-based deployment project for Ubuntu. This is used successfully in production at our company, and heard about it is tested at some other companies.
It is aimed for the 'old-school' Linux admins, using .deb packages, and not forcing to put everything into containers (but does not prevent you to separate services).

It can be found at:
https://github.com/DoclerLabs/openstack

Since it is aimed for production use, it also contains a monitoring project (maybe it will be split into a separate repo somewhere in the future).

We would be happy, if we can add it to the official docs (of course after cleaning out our rather sparse documentation).

We're talking here about deployment guides for official OpenStack
projects - and thus OpenStack-Ansible - that are part of their repositories,

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-request@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

[openstack-dev] What's Up, Doc? 18 November

Hi everyone,

Welcome to Ocata! It was great to catch up with many of you in Barcelona, and always refreshing to see the energy around our little project and catch that enthusiasm all over again :) Of course, Ocata is a very short cycle, so we've deliberately cut down our deliverables list to ensure we can squeeze it all in. We have two main priorities this release: tidying up the new Install Guides index page, and a little bit of navel gazing in terms of social structures and procedures. More on that in this newsletter!

== Progress towards Ocata ==

96 days to go!

Closed 77 bugs so far.

Release tasks are being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDeliverables

== The Road to PTG in Atlanta ==

Event info is available here: http://www.openstack.org/ptg
Purchase tickets here: https://pikeptg.eventbrite.com/

Docs is a horizontal project, so our sessions will run across the Monday and Tuesday of the event.

== Specs on review ==

== Speciality Team Reports ==

We've made some structural changes to how Speciality Teams and our regular docs meeting work. Speciality teams will now meet no more than once monthly (most on an 'as needed' basis), and participants are instead encouraged to attend the main docs meeting to discuss work and report on progress. This is aiming to keep all the information about the work we're doing a little more centralised, and give newcomers a way to find out where they can best help. It also gives us a chance to find out where we can help each other, without going to a dozen meetings!

  • API: Anne Gentle
    Karen Bradshaw has been working on updates to the openstackdocstheme that would fix this bug: https://launchpad.net/bugs/1583623. The review is up at https://review.openstack.org/#/c/393890/ and getting input from the affected teams who have recognized the need because of errors building when you have multiple API versions with very similar calls, so you end up with identical headings.
    Launchpad bug 1583623 in openstack-doc-tools "os-api-ref: duplicate labels for selectors" [Low,In progress] - Assigned to Karen Bradshaw (kbhawkey)
    I've had a couple of inquiries on IRC about "where did the draft/swagger files go?" but to meet their stated end goals, those particular files wouldn't have worked any way due to inaccuracies in the content and incomplete content.
    See the 100 api-ref doc patches up for review at: https://review.openstack.org/#/q/status:open+file:api-ref.

  • Configuration Reference and CLI Reference: Tomoyuki Kato
    No report this week

  • High Availability Guide: Andrew Beekhof
    No report this week

  • Hypervisor Tuning Guide: Joe Topjian
    No report this week

  • Installation guides: Lana Brindley
    No major updates to the guides themselves, but we are planning updates to the landing page. We're also working on getting our first deployment guide landed there, with OpenStack Ansible. I've requested design resources from foundation, but haven't heard back yet, so if you have ideas/suggestions (or design skillz!) then please let me know.

  • Networking Guide: John Davidge
    A couple of new articles are close to merging: https://review.openstack.org/#/c/361776/ - VLAN Trunking and https://review.openstack.org/#/c/356013/ - Routed Provider Networks. Need to decide how best to track the work that's going on for https://blueprints.launchpad.net/openstack-manuals/+spec/use-openstack-command. Probably a google spreadsheet or etherpad with a list of all the network guide pages to be converted, and the person working on it would be best. That way we can hopefully avoid duplicating efforts.

  • Operations and Architecture Design guides: Darren Chan
    We're slowly making progress with the arch guide, and have cloudnull onboard to help. So the focus is completing the design chapter and migrating stuff from the ops guide.

  • Security Guide: Nathaniel Dillon
    No update this week.

  • Training Guides: Matjaz Pancur
    We changed our IRC meeting to every two weeks (on even weeks) on Tuesday at 1300 UTC in #openstack-meeting-3. There will be an article published about BCN Upstream training in OpenStack's Superuser magazine. BCN Upstream training retrospective https://etherpad.openstack.org/p/upstream-training-barcelona-retrospective

  • Training labs: Pranav Salunke, Roger Luethi
    We have the python port already under review, the spec is not done yet, but we hope to get them merged soonish and in the right order :)

User guides: Joseph Robinson
* This the current work on converting the legacy commands to OS commands: https://wiki.openstack.org/wiki/Documentation/ReorganizeUserGuides#Ocata_Tasks. Thanks to csatari and visnyei and allen, there's progress happening. I need to finish adding the files affected to the checklist, and then also start making changes. Apart from that, keeping track of any admin or user guide bugs is also a task.

== Doc team meeting ==

We have re-started the docs team meetings, with a new cadence. Our first meeting was held today, with much success. Thank you to everyone who participated, either directly in IRC, or by making sure you sent me your updates ahead of schedule.

Our next meeting will be on Thursday 1 December at 2100 UTC in #openstack-meeting-alt

For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#18_November_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] What's Up, Doc? Holiday Edition!

Hi everyone,

The end of the year is nearly upon us already, and this will be my last newsletter for 2016, before I disappear for the holidays on the 16th. I've had yet another wonderful year with all you lovely OpenStack people, and I wish all of you and your families a happy and safe holiday, wherever and however you celebrate it. Here in Australia, the temperature is starting to soar, so I'm off on another cruise, followed by a few lazy days by the pool with family and friends. I'll be back in the office early in the new year, and ready to kick Ocata out of the door!

As many of you already know, I'm not planning on running for Pike PTL. If you're interested in running for PTL (for Pike or any future release), and would like a crash course in PTLing, please let me know and I can share whatever meagre wisdom I've gleaned before self nominations open in mid-January.

== Progress towards Ocata ==

82 days to go!

Closed 106 bugs so far.

Release tasks are being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDeliverables

== The Road to PTG in Atlanta ==

Event info is available here: http://www.openstack.org/ptg
Purchase tickets here: https://pikeptg.eventbrite.com/

Docs is a horizontal project, so our sessions will run across the Monday and Tuesday of the event.

The incoming PTL will be responsible for planning and running sessions at the Atlanta PTG.

== Speciality Team Reports ==

  • API: Anne Gentle
    The App Dev Support WG is working on a survey to determine which content areas to invest in for content on http://www.openstack.org/appdev (http://lists.openstack.org/pipermail/user-committee/2016-November/001469.html)

  • Configuration Reference and CLI Reference: Tomoyuki Kato
    We try to recreating the single page view for the "openstack" command. I'd like to generate the reference from source code automatically. However, python-openstackclient has many plug-ins. It is difficulty, but worth to tackle it. We need your help!

  • High Availability Guide: Andrew Beekhof
    No formal report, but Alex Settle has been doing a lot of work on this guide recently, cleaning up, and raising bugs for some of the TODO items. We need to consider if the HA guide is an ongoing concern. Ben Silverman is wondering if we can fold the content into the Ops/Arch Guides. This will be raised on the mailing list for more conversation.

  • Hypervisor Tuning Guide: Joe Topjian
    No report this week

  • Installation guides: Lana Brindley
    We've heard back from Foundation on design resources, I'm going to reply to that email today and hopefully start drafting the new design next week. I've also got Piet from the UX team on board to help. Anyone who wants to be involved with that, please contact me.

  • Networking Guide: John Davidge
    No update this week.

  • Operations and Architecture Design guides: Darren Chan
    For the Arch guide, patches for networking and compute content were merged, thanks to Ben and Shaun. For the Ops Guide, there is patch up to update the upgrades chapter and include links to the project upgrade notes: https://review.openstack.org/#/c/404528/

  • Security Guide: Nathaniel Dillon
    No update this week.

  • Training Guides: Matjaz Pancur
    BCN Upstream training article in the Superuser magazine: http://superuser.openstack.org/articles/openstack-upstream-training-revamp/ - actively looking for contributors to join the Upstream training, please see http://lists.openstack.org/pipermail/openstack-docs/2016-November/009382.html - cleaned test entries in the Launchpad bug queue and the Sandbox repository (left from the Barcelona Upstream training) - updated Training guides README.rst

  • Training labs: Pranav Salunke, Roger Luethi
    No update this week.

  • User guides: Joseph Robinson
    The legacy command conversion continues at a good pace. I have some more updates to patch today. The only obstacle I have run into is generating new output to match the OpenStack command client. Otherwise, contributors have been adding to the table, and there's been steady patching completed. Just a reminder to update the table if making a change: https://wiki.openstack.org/wiki/Documentation/ReorganizeUserGuides

== Doc team meeting ==

Our next meeting will be on Thursday 16 December at 2100 UTC in #openstack-meeting-alt

For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#1_December_2016

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] [api] Retiring fairy-slipper, the conversion tool for API docs

Hi all,

I believe that with the migration from WADL to RST complete, the use case
for fairy-slipper has also come to a close. I plan to retire it.

Share any concerns or questions you have, and I'll use the standard process
[1] to retire the repo.

Anne

  1. http://docs.openstack.org/infra/manual/drivers.html#retiring-a-project

--

Read my blog: justwrite.click https://justwriteclick.com
Subscribe to Docs|Code: docslikecode.com


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

[openstack-dev] What's Up, Doc? 13 January

Hi everyone,

Welcome to 2017. I hope you all had a chance to rest up a little before we hurtle straight into another release, as Ocata is now only 40 days away! I'll be in contact with our lovely release managers Brian and Mariia over the next week or so to kick off release management tasks. We will need people to test the Installation Guide again, too, so if you're interested in helping out there, please let me know.

As many of you already know, I'm not planning on running for Pike PTL. PTL nominations open in the week of 23 January, and I'll be working with Alex and Kato-san who have both expressed interest in taking on this role. If you're interested in running for PTL (for Pike or any future release), and would like a crash course in PTLing, please let me know and I can share whatever meagre wisdom I've gleaned.

== Progress towards Ocata ==

40 days to go!

Closed 149 bugs so far.

Deliverables are being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDeliverables

== The Road to PTG in Atlanta ==

Event info is available here: http://www.openstack.org/ptg
Purchase tickets here: https://pikeptg.eventbrite.com/

Docs is a horizontal project, so our sessions will run across the Monday and Tuesday of the event. We will be combining the docs event with i18n, so translators and docs people will all be in the room together.

The incoming PTL will be responsible for planning and running sessions at the Atlanta PTG.

Also, a quick note that the CFP and ticket sales for Boston in May are now open: https://www.openstack.org/summit/boston-2017/call-for-presentations/

== Speciality Team Reports ==

  • API: Anne Gentle
    Fairy-slipper is being retired. It was a good tool, served its purpose, and can now traipse into the sunset, thanks to AJaeger and stevemar for the help with the patches. Be sure to follow the service catalog naming conventions work going on in the API WG. And there's also a new EC2 API reference: http://developer.openstack.org/api-ref/ec2-api/

  • Configuration Reference and CLI Reference: Tomoyuki Kato
    Config Reference: Updated a few plug-ins. CLI reference: Updated a few command references and removed unsupported Block Storage API v1 and Image API v1.

  • High Availability Guide: Andrew Beekhof
    No report this week

  • Hypervisor Tuning Guide: Joe Topjian
    No report this week

  • Installation guides: Lana Brindley
    Testing for Ocata will be opening soon. Also, we need a web dev for the landing page, if you know of anyone, please get me in touch.

  • Networking Guide: John Davidge
    No update this week.

  • Operations and Architecture Design guides: Darren Chan
    Ben Silverman has spent some time refining the Compute content in the Arch Guide draft. Thanks Ben! We are also looking for more SMEs to help with the Arch Guide. So if you're interested, contact asettle or me.

  • Security Guide: Nathaniel Dillon
    No update this week.

  • Training Guides: Matjaz Pancur
    No update this week.

  • Training labs: Pranav Salunke, Roger Luethi
    No update this week.

  • User guides: Joseph Robinson
    The command conversions have happened at a good pace, the User Guide appears to be mostly complete, with the condition that the trove and manila teams do not have OpenStack commands yet. I have started checking through the Admin Guide files. I suspect there is more to convert, but it should be ready for Ocata.

== Doc team meeting ==

Our next meeting will be on Thursday 27 January at 2100 UTC in #openstack-meeting-alt

For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#13_January_2017

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] [OpenStack-docs] [Docs] PTL Candidacy for Pike

Hi everyone,

I am announcing my candidacy for the OpenStack manuals PTL position.

Some of you may know me from the 2014 Paris summit where I cooed like a pigeon [1] in a panel discussion, but I hope that most of you will know me from my documentation work across OpenStack, specifically the OpenStack manuals project and OpenStack-Ansible contributions.

I have been an active contributor to OpenStack manuals since the beginning of 2014, and have been a core member since early 2015. Over these last 3 years, I was privileged to be a part of the sprint team that authored the first edition of the OpenStack Architecture Design Guide [2] (and the subsequent swarm team that fixed it up), the team that converted the manuals from XML to RST, the specialty team that worked on the creation and curation of the Contributor Guide, and the release management team for Ocata. I also worked with the OpenStack Infra team to create the new Deployment Guides section [3] at docs.openstack.org.

I regularly work in different OpenStack projects. For example, I assisted the Swift team to curate the Swift Ops Runbook [4], and have been helping the OpenStack-Ansible team rework their documentation [5].

I am passionate about our documentation, our community, and our team’s involvement across OpenStack. OpenStack manuals was never organised and facilitated by a single person. Behind the scenes there are a great number of individuals who work hard to ensure our ship stays afloat. As PTL, I would like to continue this trend by:

  1. Improving cross-project documentation liaison relationships
    a. Over the course of the Pike release, I plan to focus on developing better relationships with the cross-project liaisons and PTL’s of individual projects. I would like to promote and encourage developers and operators to get more involved in the development of OpenStack manuals content. OpenStack manuals takes on the responsibility of documenting and maintaining guides that represent the projects and tools developers and operators are working so hard to build and maintain. This written representation of their work is equally as important as the output.
  2. Continuing with Lana’s bug-depletion legacy
    a. I plan to achieve this by reporting on completed bugs on a weekly basis and encouraging other contributors to report and fix one bug per week. When Lana first became PTL, she vowed to attack our enormous (and continuously growing) bug list. I'd like to continue this work, and will strive to find innovative ways to reduce our technical debt.

If you would like to know more about how I will work to improve our community and the manuals, I’d love to chat with you more on IRC or via email.

Coo coo,

Alexandra Settle

IRC: asettle
Twitter: dewsday
Email: a.settle@outlook.com

[1] https://youtu.be/PtomtKeJ0tc?t=1783
[2] http://docs.openstack.org/arch-design/introduction-how-this-book-was-written.html
[3] http://docs.openstack.org/project-deploy-guide/newton/
[4] http://docs.openstack.org/developer/swift/ops_runbook/index.html
[5] https://blueprints.launchpad.net/openstack-ansible/+spec/osa-install-guide-overhaul


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

[openstack-dev] What's Up, Doc? Farewell edition

Hi everyone,

I must confess, I'm feeling a little sad. This is my very last What's Up, Doc. Next week, I'll be handling the Docs PTL mantle to Alexandra Settle. I've worked with Alex in varying capacities over many years, and I have no doubt that she will be a fabulous PTL. I'm really looking forward to working with her, and seeing what new directions she's able to take this team. I want to take this opportunity to thank each and every one of you for your continued support and encouragement over the last two years (and almost-four releases!). I have had an absolute ball doing this job, and it's all because of the amazing people I get to work with every day. Of course, I'm not going anywhere just yet. I will stay on as a core contributor, and continue to help out as much as I can.

In the meantime, we have a release to get out the door! We now only have 26 days until Ocata is released, please keep an eye on the docs mailing list for updates, and consider getting your hands dirty with some Install Guide testing: https://wiki.openstack.org/wiki/Documentation/OcataDocTesting

== Progress towards Ocata ==

26 days to go!

Closed 211 bugs so far.

Release tasks are being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDeliverables
Install Guide testing is being tracked here: https://wiki.openstack.org/wiki/Documentation/OcataDocTesting

== The Road to PTG in Atlanta ==

Event info is available here: http://www.openstack.org/ptg
Purchase tickets here: https://pikeptg.eventbrite.com/

Docs is a horizontal project, so our sessions will run across the Monday and Tuesday of the event. We will be combining the docs event with i18n, so translators and docs people will all be in the room together.

Conversation topics for Docs and i18n here: https://etherpad.openstack.org/p/docs-i18n-ptg-pike

Also, a quick note that the CFP and ticket sales for Boston in May are now open: https://www.openstack.org/summit/boston-2017/call-for-presentations/

== Speciality Team Reports ==

No speciality team reports this week, as we didn't have quorum for the docs meeting.

== Doc team meeting ==

Our next meeting will be on Thursday 9 February at 2100 UTC in #openstack-meeting-alt

Meeting chair will be Alexandra Settle.

For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#27_January_2017

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

We will miss you Lana, you did a phenomenal job and welcome aboard
Alexandra!

On Thu, Jan 26, 2017 at 8:17 PM, Lana Brindley openstack@lanabrindley.com
wrote:

Hi everyone,

I must confess, I'm feeling a little sad. This is my very last What's Up,
Doc. Next week, I'll be handling the Docs PTL mantle to Alexandra Settle.
I've worked with Alex in varying capacities over many years, and I have no
doubt that she will be a fabulous PTL. I'm really looking forward to
working with her, and seeing what new directions she's able to take this
team. I want to take this opportunity to thank each and every one of you
for your continued support and encouragement over the last two years (and
almost-four releases!). I have had an absolute ball doing this job, and
it's all because of the amazing people I get to work with every day. Of
course, I'm not going anywhere just yet. I will stay on as a core
contributor, and continue to help out as much as I can.

In the meantime, we have a release to get out the door! We now only have
26 days until Ocata is released, please keep an eye on the docs mailing
list for updates, and consider getting your hands dirty with some Install
Guide testing: https://wiki.openstack.org/wiki/Documentation/
OcataDocTesting

== Progress towards Ocata ==

26 days to go!

Closed 211 bugs so far.

Release tasks are being tracked here: https://wiki.openstack.org/
wiki/Documentation/OcataDeliverables
Install Guide testing is being tracked here: https://wiki.openstack.org/
wiki/Documentation/OcataDocTesting

== The Road to PTG in Atlanta ==

Event info is available here: http://www.openstack.org/ptg
Purchase tickets here: https://pikeptg.eventbrite.com/

Docs is a horizontal project, so our sessions will run across the Monday
and Tuesday of the event. We will be combining the docs event with i18n, so
translators and docs people will all be in the room together.

Conversation topics for Docs and i18n here: https://etherpad.openstack.
org/p/docs-i18n-ptg-pike

Also, a quick note that the CFP and ticket sales for Boston in May are
now open: https://www.openstack.org/summit/boston-2017/call-for-
presentations/

== Speciality Team Reports ==

No speciality team reports this week, as we didn't have quorum for the
docs meeting.

== Doc team meeting ==

Our next meeting will be on Thursday 9 February at 2100 UTC in

openstack-meeting-alt

Meeting chair will be Alexandra Settle.

For more meeting details, including minutes and the agenda:
https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting

--

Keep on doc'ing!

Lana

https://wiki.openstack.org/wiki/Documentation/WhatsUpDoc#27_January_2017

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


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

[openstack-dev] [openstack-docs][security] Sec guide change

Hi everyone,

As of today, all bugs for the Security Guide will be managed by ossp-security-documentation and no longer will be tracked using the OpenStack manuals Launchpad.

All tracking for Security Guide related bugs can be found here: https://bugs.launchpad.net/ossp-security-documentation

Big thanks to the security team and Ian Cordasco for creating and updating the bug list in Launchpad!

Thank you,

Alex


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

Nice work!

L

On 03/02/17 05:06, Alexandra Settle wrote:
Hi everyone,

As of today, all bugs for the Security Guide will be managed by ossp-security-documentation and no longer will be tracked using the OpenStack manuals Launchpad.

All tracking for Security Guide related bugs can be found here: https://bugs.launchpad.net/ossp-security-documentation

Big thanks to the security team and Ian Cordasco for creating and updating the bug list in Launchpad!

Thank you,

Alex


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

--
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com


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

[openstack-dev] [openstack-docs] Bug smash

Hey everyone,

We have 2 weeks until the Ocata release. Hooray! We have fixed 251 so far! But, we have some more work to do…

I know everyone is busy with their respective guides and testing, but we have 24 bugs (half are wishlist!) that were assigned for Newton and Ocata that we have not fixed.

It would be great if people could take the time over the next 2 weeks to assign themselves a bug: https://goo.gl/DnZU0q (this is a Launchpad link, just wanted to save you all from the 40 lines)

If you have any questions, please reach out ☺

Cheers,

Alex


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

Correction!

251 bugs* - good to see I can type an email without errors.

On 2/8/17, 11:25 AM, "Alexandra Settle" a.settle@outlook.com wrote:

Hey everyone,

We have 2 weeks until the Ocata release. Hooray! We have fixed 251 so far! But, we have some more work to do… 

I know everyone is busy with their respective guides and testing, but we have 24 bugs (half are wishlist!) that were assigned for Newton and Ocata that we have not fixed.

It would be great if people could take the time over the next 2 weeks to assign themselves a bug: https://goo.gl/DnZU0q (this is a Launchpad link, just wanted to save you all from the 40 lines)

If you have any questions, please reach out ☺ 

Cheers,

Alex
_______________________________________________
OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


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

[openstack-dev] [docs] Docs meeting

Hello everyone,

Your friendly neighbourhood PTL reminder that the weekly OpenStack manuals (docs) IRC meeting will be Thursday, 9th of January at 2100 UTC in
in the #openstack-meeting-alt channel: http://www.timeanddate.com/worldclock/fixedtime.html?msg=Documentation+Team+Meeting&iso=20161117T21&p1=1440&ah=1

The agenda for the meeting can be found here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

Everyone is welcome to attend and bring items to discuss to the table ☺

Thanks,

Alex


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

Correction: 9th of February.

Apparently, I’m not very good at emails lately.

Thank you, Andreas ;)

From: Alexandra Settle a.settle@outlook.com
Date: Thursday, February 9, 2017 at 10:36 AM
To: "openstack-docs@lists.openstack.org" openstack-docs@lists.openstack.org, "OpenStack Development Mailing List (not for usage questions)" openstack-dev@lists.openstack.org
Subject: [OpenStack-docs] [openstack-dev][docs] Docs meeting

Hello everyone,

Your friendly neighbourhood PTL reminder that the weekly OpenStack manuals (docs) IRC meeting will be Thursday, 9th of January at 2100 UTC in
in the #openstack-meeting-alt channel: http://www.timeanddate.com/worldclock/fixedtime.html?msg=Documentation+Team+Meeting&iso=20161117T21&p1=1440&ah=1

The agenda for the meeting can be found here: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

Everyone is welcome to attend and bring items to discuss to the table ☺

Thanks,

Alex


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

[openstack-dev] [openstack-docs] What's up, Doc? 10 Feb 2017

Team team team team team,

Welcome to my first edition of What's up, Doc?

Firstly, I just want to thank everyone who supported me when I announced I would like to run for manuals PTL. Although I ran the election uncontested (like the beginning of all good dictatorships), it was wonderful to receive messages of support from everyone. I’ve slowly been ramping up and getting used to the mass influx of emails. Turns out I’m really good at sending out emails with the incorrect time and/or date. Big thanks to Andreas for informing me the next 9th of January will be in 2020.

Without further ado, let's get down to business! We have a very short window now between Ocata and the start of Pike, and we still have quite a number of things left to achieve.
- If anyone has time to dedicate to Install Guide testing - please sign up (links below). Thanks to those who have already volunteered to help Lana out!
- As per my email yesterday, I'd love to see some people out there smashing bugs! (links also below, and more info in the meeting minutes from yesterday).

== Progress towards Ocata ==

== The Road to PTG in Atlanta ==

Docs is a horizontal project, so our sessions will run across the Monday and Tuesday of the event. We will be combining the docs event with i18n, so translators and docs people will all be in the room together. Everyone welcome! Conversation topics for Docs and i18n here: https://etherpad.openstack.org/p/docs-i18n-ptg-pike

Event info is available here: http://www.openstack.org/ptg
Purchase tickets here: https://pikeptg.eventbrite.com/
Tickets for the Boston summit: https://www.openstack.org/summit/boston-2017/

== Specialty Team Reports ==

API - Anne Gentle:
The trove API docs are incomplete after migration, and a user reported the bug to the ML. Anne to log the missing clustering API info. Alex and Anne to meet with the app dev community manager at the Foundation to talk about goals for developer.openstack.org. The NFV Orchestration (tacker) team landed their API ref this week.

Configuration Reference and CLI Reference - Tomoyuki Kato:
CLI Reference: Updated some CLI references. Added aodhclient. Config Reference: Start working on Ocata updates.

High Availability Guide - Ianeta Hutchinson:
Sent a message to the ML looking for people interested in helping out on the HA guide for Pike. Planning for the PTG as I can’t attend.

Hypervisor Tuning Guide - Blair Bethwaite:
No report this week

Installation guides - Lana Brindley:
Landing page review: https://review.openstack.org/#/c/425821/12. Install guide testing is well underway.

Networking Guide - John Davidge:
Working on organising a Networking Guide working group with the neutron team at the PTG. Also been smashing bugs.

Operations and Architecture Design guides - Darren Chan:
Darren and Ben are working on an action plan for the Arch Guide to be worked on during Pike to get the current draft guide published.

Security Guide - Nathaniel Dillon:
Moved the sec-guide bugs to the sec team Launchpad. Sec and doc team to coordinate and come up with action plan for the future of the sec guide at the PTG.

Training Guides - Matjaz Pancur:
No report this week

Training labs - Pranav Salunke, Roger Luethi:
Training-labs has a rough, but working Ocata patch. Issues we found are noted on the Etherpad as you requested. We should be able to release within a week or two after Ocata is official.

User guides - Joseph Robinson:
The legacy command changes have gone through well this release, and the next steps is to check with the nova, neutron, cinder, and glance teams on the status of some specific project commands

== Doc team meeting ==

Our next meeting will be on Thursday 23 February at 2100 UTC in #openstack-meeting-alt. We will not be skipping the meeting in favor for the PTG as the docs sessions are on the Mon-Tues and I would love the opportunity to immediately report back to people who cannot attend.

Meeting chair will be me (Alexandra Settle - asettle)! \o/

For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting

--

Have a great weekend!

Alex
All round badass and supernaturally good potato peeler

IRC: asettle
Twitter: dewsday


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

[openstack-dev] Fwd: Docs project mascot

Hi everyone,

Here's the final docs logo from Foundation.

Lana

-------- Forwarded Message --------
Subject: Docs project mascot
Date: Mon, 13 Feb 2017 13:38:46 -0800
From: Heidi Joy Tretheway heidijoy@openstack.org
To: Alexandra Settle a.settle@outlook.com, Lana Brindley openstack@lanabrindley.com

Hi Lana and Alexandra,

I’m excited to finally be able to share final project logo files with you. Inside this folder, you’ll find full-color and one-color versions of the logo, plus a mascot-only version, in EPS, JPG and PNG formats. You can use them on presentations and wherever else you’d like to add some team flair.

https://www.dropbox.com/sh/htu234yuf963i9b/AAAsraXwT3a5O9HNmms4E9yFa?dl=0

At the PWG, we’ll have stickers for your team of the mascot, plus signage on your room. I’m especially excited for the project teams to see all of the logos together as one group, because they work beautifully together stylistically while making each project’s mark distinctive. Feel free to share this with your team, and thanks to you and to them for the hard work they put into reaching an agreement on the mascot. Also feel free to direct any questions my way!

photo
Heidi Joy Tretheway
Senior Marketing Manager, OpenStack Foundation
503 816 9769 &&




[openstack-dev] [openstack-docs] [i18n] PTG schedule

Hey everyone,

Ian and I have written up combined docs and I18n schedule for the PTG: https://etherpad.openstack.org/p/docs-i18n-ptg-pike

I have packed in everything on a pretty tight schedule with time allocations simply because we have a lot of big topics to talk about between the two projects and I want to make sure we cover the smaller stuff too, but this is only a recommended set of guidelines. We have the full 2 days no matter what – things can be changed. Please reach out if the time does not work for you.

I have included everyone’s names next to the sessions they have proposed. There is one session that is nameless – Upgrade Guide – please let me know if this is you (Darren Chan, maybe?)
Some of the time slots are purposefully done to accommodate for remote attendees – keep this in mind as well.

I have included a new section underneath the schedule for working sessions. I know a few docs people will be around on the Wed – Fri. If anyone is interested in getting together after the 2 days to smash some bugs, or implement a new plan, put your name down and I will organize a room for us. This will be an informal session.

Any questions, or if I have missed something, please reach out to me :)

Alex


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

[openstack-dev] [openstack-docs] HA Guide session

Hi everyone,

As per the HA discussion in the session today, we’ll be meeting in the room ‘Macon’ at the Sheraton from 3pm, on Wednesday the 22nd of February.

If you would like to join remotely, please let me know :)

Thanks,

Alex


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

[openstack-dev] Fwd: Documentation logo - revised

And here's our logo with our whole name written on it :)

L

-------- Forwarded Message --------
Subject: Documentation logo - revised
Date: Fri, 17 Feb 2017 13:30:26 -0800
From: Heidi Joy Tretheway heidijoy@openstack.org
To: Alexandra Settle a.settle@outlook.com, Lana Brindley openstack@lanabrindley.com

Here are the updated files for Documentation! Have a great weekend.
https://www.dropbox.com/sh/htu234yuf963i9b/AAAsraXwT3a5O9HNmms4E9yFa?dl=0

photo
Heidi Joy Tretheway
Senior Marketing Manager, OpenStack Foundation
503 816 9769 &&




[openstack-dev] [openstack-docs] [dev] Thursday docs meeting

Hi everyone,

The docs team will still be hosting their meeting on Thursday, 23 February at 2100 UTC in #openstack-meeting-alt. We will not be skipping the meeting in favor for the PTG as the docs sessions are on the Mon-Tues and I would love the opportunity to immediately report back to people who cannot attend.

For more meeting details, including minutes and the agenda:https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting

Thanks,

Alex


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

[openstack-dev] [openstack-docs] [dev] What's up, Doc?

Team team team team team,

Welcome to my second edition of What's up, Doc!

We have had an extremely busy week in Atlanta for the PTG. We had a really enthusiastic attendance and I am truly impressed by how much we have managed to get done. This newsletter will be a short one and focus on a small PTG update!

Our bug triager for the first 2 weeks of Pike is Darren Chan. Looking for more people to sign up and help out: https://wiki.openstack.org/wiki/Documentation/SpecialityTeams#Bug_Triage_Team

== Progress towards Pike ==

Thanks to our amazing release managers, Maria, Brian and Lana for all their amazing hard work on the Ocata release. Big thanks to Anne for stepping in at the last minute!

== The Road to the Summit in Boston ==

Voting is now open for topics. You can find the list of topics here: https://www.openstack.org/summit/boston-2017/vote-for-speakers#/
I was able to find some documentation related topics. If anyone has any more topics I am unaware of, please reply to this email thread and share your talks!

Please vote for your fellow documenter below:

  1. https://www.openstack.org/summit/boston-2017/vote-for-speakers#/17888
  2. https://www.openstack.org/summit/boston-2017/vote-for-speakers#/18078
  3. https://www.openstack.org/summit/boston-2017/vote-for-speakers#/17711

Event info is available here: http://www.openstack.org/ptg
Purchase tickets here: https://pikeptg.eventbrite.com/
Tickets for the Boston summit: https://www.openstack.org/summit/boston-2017/

== PTG Update ==

We had a very successful PTG! Thanks to all those that were able to attend. Thanks to Ian Choi and the I18n team for being wonderful collaborators. We were able to get a lot done in our horizontal sessions. For anyone that is interested, here's our etherpad with all the notes from the sessions: https://etherpad.openstack.org/p/docs-i18n-ptg-pike
Here are a few of the exciting things to look out for in Pike:

  1. High Availability Guide improvements

a. Adam Spiers and Ianeta Hutchinson will be leading the charge on the HA guide with a massive restructure and up-to-date new content.

  1. Reno release notes for OpenStack manuals

a. Adam Spiers has been working alongside John Davidge and the Infra team to work on implementing the reno release notes process for documentation. Including looking at implementing new reno templates to work specifically for documentation!

  1. Networking Guide improvements and more collaboration with the neutron team.

a. John Davidge has been working with the neutron team to develop the best way to ensure information flows into the guide. Discussions around the use of the DocImpact tag were successful.

  1. Administrator Guide changes! Keep your eye out for exciting developments.

a. Ildiko Vancsa and Joseph Robinson will be working together to come up with a new specification to implement in Queens for our Administration Guide. Development teams have been enthusiastic about implementing the project-install-guide and are looking for similar structures with the Admin Guide. Stay tuned for more news here!

I had the opportunity to report back to meeting attendees yesterday afternoon, if anyone would like to know more, here are the meeting minutes: http://eavesdrop.openstack.org/meetings/docteam/2017/docteam.2017-02-23-20.59.log.txt

== Doc team meeting ==

Our next meeting will be on Thursday 9 March at 2100 UTC in #openstack-meeting-alt.

Meeting chair will be me (Alexandra Settle - asettle)! \o/

For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting

--

Have a great weekend!

Alex
Lamp enthusiast and award winning marathon sleeper

IRC: asettle
Twitter: dewsday


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

On 24 Feb 2017, at 13:32, Alexandra Settle a.settle@outlook.com wrote:

Please vote for your fellow documenter below:

The community voting for Boston already closed.

Christian.

--
Christian Berendt
Chief Executive Officer (CEO)

Mail: berendt@betacloud-solutions.de
Web: https://www.betacloud-solutions.de

Betacloud Solutions GmbH
Teckstrasse 62 / 70190 Stuttgart / Deutschland

Geschäftsführer: Christian Berendt
Unternehmenssitz: Stuttgart
Amtsgericht: Stuttgart, HRB 756139


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

[openstack-dev] [docs] Docs PTG summary

Hi everyone,

The OpenStack manuals project had a really productive week at the first PTG in Atlanta, collaborating with the I18n team on the Monday and Tuesday for the horizontal sessions.

We were able to have several key leaders in the room, including previous documentation PTL, Anne Gentle and I18n PTL, Ian Choi to help drive a lot of the sessions. Although we had a small localized attendance, we were visited by several members of different projects such as Neutron and Security, each interested in helping contribute to the documentation project. We also had a successful first attempt at incorporating remote attendees for a few different sessions.

Following the PTG, the documentation team will be having a renewed focus on the Administration, Networking, High Availability (HA) and the Architecture Guides. These guides in particular have been items of technical debt for some time. The team at the PTG was able to collaborate and work on plans to best deal with any and all concerns. You can see all our comments, and sessions here: https://etherpad.openstack.org/p/docs-i18n-ptg-pike

Things to look out for during Pike:

  1. HA Guide

· Specialty team lead Ianeta Hutchinson and SME Adam Spiers played a big hand in planning the future of the guide. One of the major concerns was ensuring the guide was written and delivered to an appropriate audience. After collaborating during the session, and later in a cross-project working session. The team was able to smash out some new deliverables.

· You can see the comments, and the ToC planning in the HA etherpad: https://etherpad.openstack.org/p/HA_Guide

· The team will be using SMEs like Adam to help craft the guide, with further assistance from the OSIC team.

  1. Administration Guide

· The topic of a project-specific admin guide has come up previously, but this time with more gusto. As a result of the discussions in the PTG sessions, Ildiko Vancsa and specialty team lead Joseph Robinson will be working together over the course of the Pike release to fashion a specification.

· https://etherpad.openstack.org/p/docs-i18n-ptg-pike-repos

  1. Networking Guide

· Specialty team lead John Davidge will be working closely with the neutron team to work on a better information delivery method using the DocImpact tag. He will also be working on reorganizing the guide, and working with the HA team to avoid duplication of content.

· https://etherpad.openstack.org/p/networking-guide-improvements

  1. Security Guide

· The security guide team and the documentation team got together to work on the future of the Sec guide. Due to limited resources, there has been a pause in necessary updates. The security team working with OSIC have volunteered their team to employ a tactical effort to deliver 10 non-wishlist bugs.

· Further planning is underway regarding the audience, services, and pre-existing content.

· You can find more information here: https://etherpad.openstack.org/p/docs-i18n-ptg-pike (line 202)

  1. Architecture and Operations Guide(s)

· The draft guide that Ben Silverman and specialty team lead Darren Chan have been working on tirelessly for the last few cycles is coming out of the darkness and being published. Hopefully this will generate more interest in the guide (help!). The team will be working on improving the visibility of issues overall, and creating an architecture template use case template to provide guidance for contributors.

· The Ops Guide team will also be focusing on a single source of truth for Networking content, and discussing best course of action for the Upgrade notes.

· For more information: https://etherpad.openstack.org/p/docs-i18n-ptg-pike (line 271)

  1. Reno release notes

· Adam Spiers is working alongside Doug Hellmann to enable reno release notes for the Pike release. https://docs.openstack.org/developer/reno/

· Adam already has a preliminary patch up: https://review.openstack.org/#/c/437611/ keep your eyes open for more!

  1. Archiving of documentation

· Specialty team lead Brian Moss will be working with the tools team and Lana Brindley to implement the plan for archiving as detailed here: https://review.openstack.org/#/c/426047/

· The docs team will be working with the I18n team to find a use case that suits both scenarios.

· More information and notes: https://etherpad.openstack.org/p/docs-i18n-ptg-pike (line 104)

  1. Website theme

· The docs team will be working on unifying the themes used (oslo.sphinx and openstackdocstheme). Specialty team lead Kato Tomoyuki will be working alongside Anne Gentle to write a specification for the new integration.

We also had a few new contributors that was really great to see. Thanks to everyone that came along to the documentation session locally or remotely. It was highly productive and looking forward to auctioning everything in Pike!

Any questions? Please let me know! I apologise if I have missed anything. The etherpad is full of info!

Thanks,

Alex


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

[openstack-dev] [openstack-docs] [dev] What's up, doc?

Team team team team team,

It's been a crazy few weeks since the PTG ramping up our goals for Pike! Big thanks to everyone who has really hit the ground running with our new set of objectives.

This week I have been helping out Ianeta with the High Availability Guide ToC plan, (which you can review here: https://review.openstack.org/#/c/440890/ ) and Rob Clark with the Security Guide plan (https://etherpad.openstack.org/p/sec-guide-pike ). I have also been working alongside Brian and the nova team to unblock ourselves from a particularly nasty, critical, bug affecting the Install Guide. For more information: https://bugs.launchpad.net/openstack-manuals/+bug/1663485

Big thanks to Darren Chan who has been doing an awesome job for the last two weeks in keeping our bug list under control. We are down to an amazing 108 bugs in queue.

Next week, we have Ianeta who will be looking after the bug triage liaison role!

If you're sitting there thinking "bugs are for me, I really love triaging bugs!" well, you're in luck! We have a few spots open for the rest of the cycle: https://wiki.openstack.org/wiki/Documentation/SpecialityTeams#Bug_Triage_Team

== Progress towards Pike ==
https://www.timeanddate.com/countdown/newyear?p0=24&msg=Pike+release&ud=1&font=slab

Bugs closed in Pike: 32! You guys rock :)

== The Road to the Summit in Boston ==
The summit schedule has been announced: https://www.openstack.org/summit/boston-2017/summit-schedule/#day=2017-05-08

I will be representing the docs team at the summit for the new 'Project Update' session. For more information: https://www.openstack.org/summit/boston-2017/summit-schedule/global-search?t=Project+Update+-+Documentation

Let me know if you had any doc talks accepted!

== Speciality Team Reports ==

API - Anne Gentle: One prominent change is that the Block Storage API v2 is now exactly replicated with v3 and so is now marked Deprecated. The list of all OpenStack APIs is now also here: https://developer.openstack.org/#api and you can see them based on support level here: https://developer.openstack.org/api-guide/quick-start/

Configuration Reference and CLI Reference - Tomoyuki Kato: N/A

High Availability Guide - Ianeta Hutchinson: So, we have this patch https://review.openstack.org/#/c/440890/13 to establish the new ToC for HA Guide. We are trying to move all content that is relevant in the current guide over to the new ToC. From there, we will be filing bugs to start collaboration with the OSIC DevOps team who have signed up to adopt-a-guide and will be helping to provide content as SME's.

Hypervisor Tuning Guide - Blair Bethwaite: The Scientific-WG is considering proposing a hypervisor tuning + guide session for the Boston Forum though, so hopefully if that goes ahead it will create some renewed interest.

Installation guides - Lana Brindley: Waiting to sort out the last couple of bugs before we branch, hopefully next week.

Networking Guide - John Davidge: Huge number of patches this week on the RFC 5737 fix[1] - thanks to caoyuan! Continued progress on replacing neutronclient commands with OSC versions. Thank you to all contributors. A patch[2] changing a documented use of ’tenant’ to ‘project’ sparked a discussion in the neutron team about the mixture of terminology in neutron, with the conclusion that all remaining references to ’tenant’ in our config files and elsewhere are to be replaced with ‘project’ as soon as possible. Some of these will require deprecation cycles. Impact on the networking guide should be minimal.
[1] https://launchpad.net/bugs/1656378 [2] https://review.openstack.org/#/c/43816

Operations and Architecture Design guides - Darren Chan: A patch to move the draft Arch Guide to docs.o.o has merged. The previous guide has been moved to a "to archive" directory until the archiving process is ready. The Arch Guide working group met this week to rearchitect and scope the design content. We're currently focussed on the storage content.

Security Guide - Nathaniel Dillon: Rob Clark (PTL) and Alex are in the process of planning the ins and out of the overhaul of the guide. We're talking about dramatically reducing the scope, and introducing new, maintainable, content. Rob (hyakuhei) is also looking at getting a sprint in Austin at some point to get the security team all together and pump out some content. We also have the OSIC Security team pumping out some of the main, non-wishlist, bugs at preset.

Training Guides - Matjaz Pancur: N/A

Training labs - Pranav Salunke, Roger Luethi: We have pushed the current state of the Ocata training-labs changeset in case others find it useful. The scripts follow the install-guide and https://review.openstack.org/#/c/438328/ . The resulting cluster cannot launch instances because it fails to find a host (just like others following the install-guide have reported).

Admin and User guides - Joseph Robinson: For the User and Admin Guides, I've been looping through the bug list - there are SDK bugs and the issue of moving the python SDK examples, which was discussed back in Newton. There are also two telemetry bugs, which I need to contact the liaisons for. The only other point, is reviewing the Admin Guide migration spec: https://review.openstack.org/#/c/439122/

== Doc team meeting ==
Our next meeting will be on Thursday, 23 March at 2100 UTC in #openstack-meeting-alt.
For more meeting details, including minutes and the agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting

I am unavailable to be the meeting chair this week :( is someone able to host? Ping or email if you are able to help out!

--
Have a great weekend!
Alex
Fastest typer in the universe (2014) and expert cactus photographer
IRC: asettle
Twitter: dewsday


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

[openstack-dev] [openstack-doc] Docs team meeting

Hey everyone,

The docs meeting will continue today in #openstack-meeting-alt as scheduled (Thursday at 21:00 UTC). For more details, and the agenda, see the meeting page: - https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

The meeting with be hosted by Joseph Robinson, as I have some personal business to attend to this evening.

Specialty team leads – if you are unable to attend the meeting, please send me your team reports to include in the doc newsletter.

Thanks,

Alex


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

[openstack-dev] [openstack-doc] [dev] Docs team meeting tomorrow

Hey everyone,

The docs meeting will continue today in #openstack-meeting-alt as scheduled (Thursday at 21:00 UTC). For more details, and the agenda, see the meeting page: - https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

Specialty team leads – if you are unable to attend the meeting, please send me your team reports to include in the doc newsletter.

Doc team – I highly recommend you attend. In light of the OSIC news, we are heavily affected and attendance would be appreciated to discuss future actions.

Thanks,

Alex


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

Hey everyone,

Just to clarify – that is Thursday the 20th of April, 2100 UTC.

Apologies for any confusion – just attempting to get ahead of the game and forgot to remove “today”.

See you there,

Alex

From: Alexandra Settle a.settle@outlook.com
Reply-To: "OpenStack Development Mailing List (not for usage questions)" openstack-dev@lists.openstack.org
Date: Wednesday, April 19, 2017 at 11:45 AM
To: "openstack-docs@lists.openstack.org" openstack-docs@lists.openstack.org
Cc: "OpenStack Development Mailing List (not for usage questions)" openstack-dev@lists.openstack.org
Subject: [openstack-dev] [openstack-doc] [dev] Docs team meeting tomorrow

Hey everyone,

The docs meeting will continue today in #openstack-meeting-alt as scheduled (Thursday at 21:00 UTC). For more details, and the agenda, see the meeting page: - https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

Specialty team leads – if you are unable to attend the meeting, please send me your team reports to include in the doc newsletter.

Doc team – I highly recommend you attend. In light of the OSIC news, we are heavily affected and attendance would be appreciated to discuss future actions.

Thanks,

Alex


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

[openstack-dev] [openstack-doc] [dev] Docs team meeting today

Hey everyone,

The docs meeting will continue today in #openstack-meeting-alt as scheduled (Thursday at 21:00 UTC). For more details, and the agenda, see the meeting page: - https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

Last meeting before the summit ☺

Thanks,

Alex


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

[openstack-dev] [api] [docs] Contributor and reviewer stats for API docs

Hi all,

I've started a patch to the openstack-infra/reviewstats repo [1] to measure
the number of reviews, reviewers, contributors, and contributions to API
docs where the docs are housed in project repos.

A couple of goals can be realized if we know more: to determine the experts
in the speciality and to figure out if there are processes that can be
improved, or projects that can use extra help. And, to improve both the API
docs processes and content.

Both my Python and bash skills are rudimentary on a good day so I'd like to
get some help and learn at the same time so I can improve. Is the patch on
the right track? Is this the right repo to get data (or is it really for
reviews only)? Take a look and let me know.

Thanks in advance -
Anne

  1. https://review.openstack.org/#/c/461280/

--

Read my blog: justwrite.click
Subscribe to Docs|Code: docslikecode.com


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

[openstack-dev] [all] Consolidating web themes

Hi all,

I wanted to make you all aware of some consolidation efforts I'll be
working on this release. You may have noticed a new logo for OpenStack, and
perhaps you saw the update to the web design and headers on
docs.openstack.org as well.

To continue these efforts, I'll also be working on having all docs pages
use one theme, the openstackdocstheme, that has these latest updates.
Currently we are using version 1.8.0, and I'll do more releases as we
complete the UI consolidation.

I did an analysis to compare oslosphinx to openstackdocstheme, and I wanted
to let this group know about the upcoming changes so you can keep an eye
out for reviews. This effort will take a while, and I'd welcome help, of
course.

There are a few UI items that I don't plan port from oslosphinx to
openstackdocstheme:

Quick search form in bottom of left-hand navigation bar (though I'd welcome
a way to unify that UI and UX across the themes).
Previous topic and Next topic shown in left-hand navigation bar (these are
available in the openstackdocstheme in a different location).
Return to project home page link in left-hand navigation bar. (also would
welcome a design that fits well in the openstackdocstheme left-hand nav)
Customized list of links in header. For example, the page athttps://
docs.openstack.org/infra/system-config/ contains a custom header.
When a landing page like https://docs.openstack.org/infra/ uses oslosphinx,
the page should be redesigned with the new theme in mind.

I welcome input on these changes, as I'm sure I haven't caught every
scenario, and this is my first wider communication about the theme changes.
The spec for this work is detailed here: http://specs.openstack.
org/openstack/docs-specs/specs/pike/consolidating-themes.html

Let me know what I've missed, what you cannot live without, and please
reach out if you'd like to help.

Thanks,
Anne

--
Technical Product Manager, Cisco Metacloud
annegentle@justwriteclick.com
@annegentle


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

This all sounds really great ☺ thanks for taking it on board, Anne!

No questions at present ☺ looking forward to seeing the new design!

From: Anne Gentle annegentle@justwriteclick.com
Reply-To: "OpenStack Development Mailing List (not for usage questions)" openstack-dev@lists.openstack.org
Date: Monday, May 15, 2017 at 2:33 PM
To: "openstack-docs@lists.openstack.org" openstack-docs@lists.openstack.org, OpenStack Development Mailing List openstack-dev@lists.openstack.org
Subject: [openstack-dev] [all] Consolidating web themes

Hi all,

I wanted to make you all aware of some consolidation efforts I'll be working on this release. You may have noticed a new logo for OpenStack, and perhaps you saw the update to the web design and headers on docs.openstack.org as well.

To continue these efforts, I'll also be working on having all docs pages use one theme, the openstackdocstheme, that has these latest updates. Currently we are using version 1.8.0, and I'll do more releases as we complete the UI consolidation.

I did an analysis to compare oslosphinx to openstackdocstheme, and I wanted to let this group know about the upcoming changes so you can keep an eye out for reviews. This effort will take a while, and I'd welcome help, of course.

There are a few UI items that I don't plan port from oslosphinx to openstackdocstheme:

Quick search form in bottom of left-hand navigation bar (though I'd welcome a way to unify that UI and UX across the themes).
Previous topic and Next topic shown in left-hand navigation bar (these are available in the openstackdocstheme in a different location).
Return to project home page link in left-hand navigation bar. (also would welcome a design that fits well in the openstackdocstheme left-hand nav)
Customized list of links in header. For example, the page athttps://docs.openstack.org/infra/system-config/ contains a custom header.
When a landing page like https://docs.openstack.org/infra/ uses oslosphinx, the page should be redesigned with the new theme in mind.

I welcome input on these changes, as I'm sure I haven't caught every scenario, and this is my first wider communication about the theme changes. The spec for this work is detailed here: http://specs.openstack.org/openstack/docs-specs/specs/pike/consolidating-themes.html

Let me know what I've missed, what you cannot live without, and please reach out if you'd like to help.

Thanks,
Anne

--
Technical Product Manager, Cisco Metacloud
annegentle@justwriteclick.com
@annegentle


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

[openstack-dev] [doc] Docs team meeting

Hey everyone,

The docs meeting will continue today in #openstack-meeting as scheduled (Thursday at 16:00 UTC). For more details, and the agenda, see the meeting page: - https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

The meeting chair will be me! Hope you can all make the new time ☺

Thanks,

Alex


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

Hey everyone,

The docs meeting will continue today in #openstack-meeting as scheduled (Thursday at 16:00 UTC). For more details, and the agenda, see the meeting page: - https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting

The meeting chair will be me! Hope you can all make it ☺

Thanks,

Alex


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

[openstack-dev] [openstack-doc] [dev] What's up doc? Summit recap edition

Hi everyone,

The OpenStack manuals project had a really productive week at the OpenStack summit in Boston. You can find a list of all the etherpads and attendees here: https://etherpad.openstack.org/p/docs-summit

As we all know, we are rapidly losing key contributors and core reviewers. We are not alone, this is happening across the board. It is making things harder, but not impossible. Since our inception in 2010, we’ve been climbing higher and higher trying to achieve the best documentation we could, and uphold our high standards. This is something to be incredibly proud of. However, we now need to take a step back and realise that the amount of work we are attempting to maintain is now out of reach for the team size that we have. At the moment we have 13 cores, of which none are full time contributors or reviewers. This includes myself.

That being said! I have spent the last week at the summit talking to some of our leaders, including Doug Hellmann (cc’d), Jonathan Bryce and Mike Perez regarding the future of the project. Between myself and other community members, we have been drafting plans and coming up with a new direction that will hopefully be sustainable in the long-term.

I am interested to hear your thoughts. I want to make sure that everyone feels that we’re headed in the right direction first and foremost. All of these action items are documented in this WIP etherpad: https://etherpad.openstack.org/p/doc-planning

Some further highlights from the event…

· The documentation team was represented by myself, Olga, and Alex Adamov for the Project Update: Documentation on the Monday. If you’d like to catch up with what we talked about, the video is available online now: https://www.youtube.com/watch?v=jcfbKxbpRvc The translation team PTL, Ian Choi, also had a session about getting more involved with the I18N team. You can view that video here: https://www.youtube.com/watch?v=ybFI4nez_Z8

· Ian and I also hosted the joint I18N and documentation onboarding session. We were visited by some friendly faces, and some new ones. Between Ian and myself, we discussed the documentation and translation workflows, and how to get involved (the mailing list, IRC channel, etc). Which was lots of fun :) we’d love to see more people there in the future, hopefully we’ll slowly get there!

· This week I was focusing heavily on making the community aware that the documentation team was struggling to maintain contributors, but continuing with the same amount of work. This was a heavy conversation to be having, but it posed some really interesting questions to key leaders, and hopefully raised appropriate concerns. Ildiko and I hosted “OpenStack documentation: The future depends on all of us”. This was a really interesting session. I was able to pose to the group of attendees that the documentation team was struggling to maintain contributions. Major Hayden was kind enough to take notes during the session, you can find those here: https://etherpad.openstack.org/p/doc-future The project teams that came and represented their groups were interested in discussing the project-specific documentation (is living in the project’s repo tree the best place?) and voiced concerns I had otherwise not heard before. I recommend reading the notes to get a better idea :)

· Kendall Nelson and Ildiko also hosted a session on the OpenStack Upstream Institute highlights. I recommend watching the video which is now live and available here: https://www.openstack.org/videos/boston-2017/openstack-upstream-institute-highlights

· One of the key takeaways from the summit was the session that I joint moderated with Melvin Hillsman regarding the Operations and Administration Guides. You can find the etherpad with notes here: https://etherpad.openstack.org/p/admin-ops-guides The session was really helpful – we were able to discuss with the operators present the current situation of the documentation team, and how they could help us maintain the two guides, aimed at the same audience. The operator’s present at the session agreed that the Administration Guide was important, and could be maintained upstream. However, they voted and agreed that the best course of action for the Operations Guide was for it to be pulled down and put into a wiki that the operators could manage themselves. We will be looking at actioning this item as soon as possible.

These action items will free up the documentation team to become gate keepers and reviewers of documentation. Our key focus as a team will be on the tooling for the docs.openstack.org site (including the API docs).

I’m really interested to hear everyone’s thoughts going forward – this is not set in stone. We need to change our strategy, and now is the time. If you’d rather reach out and discuss this personally, asettle on IRC is always the best place to find me.

Thanks,

Alex


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

[openstack-dev] [os-upstream-institute] Meeting Today!

Hello Everyone,

Its a pretty short agenda[1] today so feel free to add things you think we
need to discuss :)

See you in #openstack-meeting-3 at 20:00 UTC!

-Kendall (diablo_rojo)

[1]https://etherpad.openstack.org/p/openstack-upstream-institute-meetings


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

[openstack-dev] [I18n] Inviting to Zanata (translation platform) webinar: June 8th at 13:00 UTC

Hello,

I am organizing a webinar by inviting Zanata (OpenStack translation
platform) development team
as an invited speaker and seeing #openstack-meeting IRC channel for
questions and answers
on tomorrow (June 8th) 13:00 UTC.

I would like to invite to all who are interested in OpenStack
translation platform
and which new features I18n team is expecting with a newer version of
Zanata.

With many thanks,

/Ian

(
http://lists.openstack.org/pipermail/openstack-i18n/2017-June/002933.html )
-------- Original Message --------
Subject: [I18n] Zanata webinar with IRC meeting (qna): June 8th at
13:00 UTC
Date: Wed, 7 Jun 2017 14:21:19 +0900
From: Ian Y. Choi ianyrchoi@gmail.com
To: Openstack-i18n openstack-i18n@lists.openstack.org

Hello,

I am glad to announce that there will be a webinar from Zanata
development team.

  • Title: The features since 3.9 in Zanata
  • Date & Time: June 8th at 13:00 UTC (presentation will be for 30-40
    minutes)
  • Invited speaker: Patrick Huang (Senior Software Engineer in Red Hat)
  • Presentation description:
    Zanata [1] is an open source translation platform and OpenStack I18n
    team [2]
    uses it as a translation platform [3] running upon openstack-infra [4].
    At the moment translate.openstack.org is running Zanata version 3.9.6.
    Here we will have a preview of the new features developed by Zanata
    team since 3.9.x.
    This will help us to decide when to upgrade to newer version as well
    as better
    utilize the tool once it's upgraded.
  • YouTube Live URL: https://www.youtube.com/watch?v=mVCSAfk4t54

During this webinar, I18n IRC meeting (#openstack-meeting freenode IRC
channel)
will be used for questions and answers on the webinar.

Also, I have heard that YouTube Live access might be limited to some
countries.
For that, please tell me for me to prepare a channel with Skype for
Business URL.
Note that the attendees using Skype for Business might be muted.

With many thanks,

/Ian

[1] http://zanata.org/
[2] https://wiki.openstack.org/wiki/I18nTeam
[3] https://translate.openstack.org
[4] http://git.openstack.org/cgit/openstack-infra/puppet-zanata


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

[openstack-dev] [openstack-doc] [dev] Doc team meeting cancellation

Hi everyone,

Next week, Thursday the 15th of June, the OpenStack manuals meeting is cancelled as I will be PTO.

The next documentation team meeting will be the following bi-weekly allotment on the 29th of June.

If anyone has any pressing concerns, please email me and I will get back to you when I am able. I will return online on the 19th of June.

Thanks,

Alex


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

[openstack-dev] [openstack-docs][dev][all] Documentation repo freeze

Hi everyone,

As of today - Monday, the 19th of June – please do NOT merge any patches into the openstack-manuals repository that is not related to the topic: “doc-migration”.

We are currently in the phase of setting up for our MASSIVE migration and we need to ensure that there will be minimal conflicts.

You can find all patches related to that topic here: https://review.openstack.org/#/q/status:open+project:openstack/openstack-manuals+branch:master+topic:doc-migration

The only other patches that should be passed is the Zanata translation patches.

If there are any concerns or questions, please do not hesitate to contact either myself or Doug Hellmann for further clarification.

Thanks,

Alex


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

On Mon, 19 Jun 2017 15:56:35 +0000
Alexandra Settle a.settle@outlook.com wrote:

Hi everyone,

As of today - Monday, the 19th of June – please do NOT merge any patches into
the openstack-manuals repository that is not related to the topic:
“doc-migration”.

We are currently in the phase of setting up for our MASSIVE migration and we
need to ensure that there will be minimal conflicts.

You can find all patches related to that topic here:
https://review.openstack.org/#/q/status:open+project:openstack/openstack-manuals+branch:master+topic:doc-migration

The only other patches that should be passed is the Zanata translation patches.

If there are any concerns or questions, please do not hesitate to contact either
myself or Doug Hellmann for further clarification.

Can we still merge into stable branches? As the migration only affects
content in master, I think there's no need to freeze stable branches.

Thanks,
pk


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

[openstack-dev] [doc[ptls] Doc meeting

Hey everyone,

The docs meeting will continue in #openstack-meeting as scheduled (Thursday, 29th of June at 16:00 UTC).

There will be no official agenda, I am opening up this meeting for any docs liaisons and PTLs to come and chat about the docs migration and any questions they may have.

The meeting chair will be me! Hope you can all make it ☺

Thanks,

Alex


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

Re: [openstack-dev] [Openstack-operators] [doc[ptls] Doc meeting

Hi everyone,

If you have any questions/concerns/comments/feelings you have about the doc migration, bring ‘em to #openstack-meeting at 1600UTC today :)

I’ll be there to chat instead of our regularly scheduled meeting :)

Cheers,

Alex

From: Alexandra Settle a.settle@outlook.com
Date: Wednesday, June 28, 2017 at 6:45 PM
To: "'openstack-docs@lists.openstack.org'" openstack-docs@lists.openstack.org, "OpenStack Development Mailing List (not for usage questions)" openstack-dev@lists.openstack.org
Cc: "openstack-operators@lists.openstack.org" openstack-operators@lists.openstack.org
Subject: [Openstack-operators] [openstack-dev][doc[ptls] Doc meeting

Hey everyone,

The docs meeting will continue in #openstack-meeting as scheduled (Thursday, 29th of June at 16:00 UTC).

There will be no official agenda, I am opening up this meeting for any docs liaisons and PTLs to come and chat about the docs migration and any questions they may have.

The meeting chair will be me! Hope you can all make it ☺

Thanks,

Alex


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

[openstack-dev] [doc] dropping "draft" and series-specific publishing for docs.o.o

Docs team,

We have two sets of changes happening in openstack-manuals that
will simplify managing the content there, and that will .

Over the last couple of weeks we have removed several guides from
the repository. The remaining guides are not version-specific, which
allows us stop creating stable branches of that repository. We will
continue to publish from stable/newton and stable/ocata for as long
as those versions of the guides are supported.

I am also preparing a series to patches [1] to rearrange some of
the template pages to let us publish directly from master to docs.o.o,
without using a separate "draft" directory that requires special
effort at the end of a release cycle. When the series is approved
(specifically when [2] lands), changes approved in the master branch
will go live on the site within an hour or so of merging. They will
no longer be published to the /drafts folder.

Both of these are changes to the current process, so we wanted to
ensure that all contributors (and especially reviewers) were aware
of the changes. Please keep this in mind when approving future
changes.

The last patch in the series [3] updates the instructions for the
end-of-release process based on these changes. I want to make sure
these instructions are clear so that someone other than me can
perform the steps, so I need your feedback on that patch especially.

Doug

[1] https://review.openstack.org/#/q/project:openstack/openstack-manuals+topic:doc-migration/no-more-drafts
[2] https://review.openstack.org/484971
[3] https://review.openstack.org/485789


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

On 2017-07-20 21:11, Doug Hellmann wrote:
Docs team,

We have two sets of changes happening in openstack-manuals that
will simplify managing the content there, and that will .

Over the last couple of weeks we have removed several guides from
the repository. The remaining guides are not version-specific, which
allows us stop creating stable branches of that repository. We will
continue to publish from stable/newton and stable/ocata for as long
as those versions of the guides are supported.

The only guide that was version specific and is still around is the
Install Guide. But we moved all OpenStack content out and left only the
generic content in. I think we can just keep this unversioned and add
version specific instructions where needed like "If you use Queens, ...".

So, let's change the Install Guide to be unversioned and get rid of
branching!

I am also preparing a series to patches [1] to rearrange some of
the template pages to let us publish directly from master to docs.o.o,
without using a separate "draft" directory that requires special
effort at the end of a release cycle. When the series is approved
(specifically when [2] lands), changes approved in the master branch
will go live on the site within an hour or so of merging. They will
no longer be published to the /drafts folder.

Both of these are changes to the current process, so we wanted to
ensure that all contributors (and especially reviewers) were aware
of the changes. Please keep this in mind when approving future
changes.

The last patch in the series [3] updates the instructions for the
end-of-release process based on these changes. I want to make sure
these instructions are clear so that someone other than me can
perform the steps, so I need your feedback on that patch especially.

thanks a lot for driving all of this, Doug! I really like the way where
this goes,

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-request@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

[openstack-dev] [openstack-doc] Attending PTG?

Hey everyone,

Put your hand in the air* if you’re attending the PTG!

Myself and the potential PTL will need to start planning shortly, and it would be good to get an idea of numbers, and who we are planning for.

I will be looking at hosting a working bee or hack session for migration related issues throughout the week.

Cheers,

Alex

*reply to this ML thread


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

On 07/21/2017 09:41 AM, Alexandra Settle wrote:

Put your hand in the air* if you’re attending the PTG!

Aye! I'll be there, air and ground travel willing. Several of my
colleagues will be there as well.

I will be looking at hosting a working bee or hack session for
migration related issues throughout the week.

I'd be up for a good late-night hack-a-thon for any
porting/migration/patching issues that come up.

--
David A. Desrosiers


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

[openstack-dev] [docs] [training-guides] Moving from Hieroglyph for rendering slides

Hi all,

Andreas filed a bug report [1] that can impact what will we use to render slides for Upstream University and other training related slide material in the future. We’ve already had many discussions at Training guides meetings about moving to some other more actively maintained/developed framework for slides.

We were leaning towards adopting a widely popular Reveal.js [2]. On the downside, that probably also means that we will have to convert slide material from RST to MD, as RST is not directly supported. With a shrinking (Docs&Training guides) contributors, that could be a problem.

Any other ideas or preferences?

Cheers,
Matjaz

[1] https://bugs.launchpad.net/openstack-training-guides/+bug/1708240
[2] https://github.com/hakimel/reveal.js/


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

On Thursday, 3 August 2017 18:18:31 CEST Pančur, Matjaž wrote:
Hi all,

Andreas filed a bug report [1] that can impact what will we use to render
slides for Upstream University and other training related slide material in
the future. We’ve already had many discussions at Training guides meetings
about moving to some other more actively maintained/developed framework for
slides.

We were leaning towards adopting a widely popular Reveal.js [2]. On the
downside, that probably also means that we will have to convert slide
material from RST to MD, as RST is not directly supported. With a shrinking
(Docs&Training guides) contributors, that could be a problem.

Maybe you already discussed it, but can't you use pandoc to convert from rst
to reveal.js?

Ciao
--
Luigi


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

[openstack-dev] [docs][ptl] Candidacy for Docs

Hi all,

I'd like to announce my candidacy for PTL of the docs project for Queens.

I've been active in various open source documentation and
translation projects since 2007 and started contributing to OpenStack
docs during the Mitaka cycle, both upstream and in the RDO Project.

The docs project has recently seen a significant decrease in both the
number of submitted updates and contributors, but thanks to a group of
dedicated people in the community, we've managed to come up with a clear
plan to migrate docs over to individual projects, restructure them and
reduce the scope to keep them maintainable. This is now well underway and
I'd like to help the team and the community drive and continue with this
work.

In docs, we generally like to keep it rather short and simple, so let me
summarize the main three points as follows:

Support and help drive the remaining tasks in restructuring and/or moving
content from the core docs suite.

Help establish the docs team as content editors for individual project docs
when needed or requested.

Stay open and friendly to new contributors, no matter if they are
prospective core members or drive-by docs contributors, with the
understanding that docs are a great way to get involved in the project for
both the non- and developers.

Thank you,
pk

--
Petr Kovar
Sr. Technical Writer | Customer Content Services
Red Hat Czech, Brno


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

[openstack-dev] [Docs][Elections] PTL candidacy for Queens

Hello everyone,

I would like to announce my candidacy for Documentation PTL (Queens).

First of all, I wish to introduce myself briefly. I have been working on the bugs
of openstack-manuals project since the Liberty release. And the most I fixed is
the bugs of the Install Guide. In my opinion, Openstack is not very friendly with
new hand. If they install their first openstack environment according to our Install
Guide which may not be very accurate, she or he would be in a mess. I will continue
to focus on document bugs whether as a reviewer or PTL.

In this cycle, Alex( asettle) has coordinated the doc migration work [1]. I wish to
take this opportunity to thank all members of the OpenStack community who partcipated
in this work. We cannot achieve such seriously bug stuff without your cooperation. :)

As you can see, we removed several guides from openstack-manuals project. There are
still many things [2] we have not yet to accomplished after the doc migration.
Some of these problems we already have solutions. But the others need to be discussed.
We are welcome everyone to join in our discussion[3]. It would be wonderful if you can
give us some ideas!

If I am elected PTL of the Documentation project, my focuses for the coming release
are to grow the Documentation team, keep the accuracy of documents, and work closely
with other projects to help them imporve documents.

Thanks for your consideration, and I am looking forward to work together with all of
you on getting the OpenStack documents to the next stage.

Cheers,

Chason

Email: chason.chan@foxmail.com
IRC: chason
Launchpad: chen-xing

[1] https://etherpad.openstack.org/p/doc-migration-tracking
[2] https://etherpad.openstack.org/p/doc-future-problems
[3] https://etherpad.openstack.org/p/denver-doc-PTG


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

[openstack-dev] [docs] [training-guides] Team meeting reminder

Hi all,

Just a reminder: Training guides team meeting is today (Tuesday) at 1300UTC, #openstack-meeting-3.

On the agenda [1] is moving from Hieroglyph for rendering slides [2].

-Matjaz

[1] https://etherpad.openstack.org/p/training-guides-meeting-agenda
[2] http://lists.openstack.org/pipermail/openstack-dev/2017-August/120598.html


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

[openstack-dev] [docs] Doc meeting Thursday

Hi everyone,

With the upcoming PTG and all of the big changes with the migration, I will be hosting the docs meeting as normally scheduled in #openstack-meeting on Thursday, 10th of August at 16:00UTC.

I will send out the agenda closer to the day. I strongly urge all to attend. I know it’s not the best time in the world, but we’re closing in on the first release for the doc team with the new release format.

The meeting chair will be me – although I’ll be juggling my regular conflict at the same time! Hope you can all make it :)

Thanks,

Alex


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

Reminder: Docs meeting as normally scheduled in #openstack-meeting today at 16:00UTC.

Agenda: https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting

Thanks,

Alex

From: Alexandra Settle a.settle@outlook.com
Date: Tuesday, August 8, 2017 at 11:13 AM
To: openstack-docs openstack-docs@lists.openstack.org, "OpenStack Development Mailing List (not for usage questions)" openstack-dev@lists.openstack.org
Subject: [docs] Doc meeting Thursday

Hi everyone,

With the upcoming PTG and all of the big changes with the migration, I will be hosting the docs meeting as normally scheduled in #openstack-meeting on Thursday, 10th of August at 16:00UTC.

I will send out the agenda closer to the day. I strongly urge all to attend. I know it’s not the best time in the world, but we’re closing in on the first release for the doc team with the new release format.

The meeting chair will be me – although I’ll be juggling my regular conflict at the same time! Hope you can all make it :)

Thanks,

Alex


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

Re: [openstack-dev] [OpenStack-docs] [all][elections] Project Team Lead Election Conclusion and Results

Sigh. The Queen release deliverables*, not the Pike release deliverables.

One day I will send out an email without something incorrect.

From: Alexandra Settle a.settle@outlook.com
Date: Thursday, August 17, 2017 at 10:22 AM
To: openstack-docs openstack-docs@lists.openstack.org, "OpenStack Development Mailing List (not for usage questions)" openstack-dev@lists.openstack.org
Subject: Re: [OpenStack-docs] [openstack-dev] [all][elections] Project Team Lead Election Conclusion and Results

Hi everyone,

The PTL nomination period is now over, so I'm pleased to be able to confirm that Petr Kovar is our new PTL for Queens.

Congratulations, Petr! I am excited to be working with you on the doc team future, and I can't wait to see what the docs team can achieve under your stewardship.

I would also like to thank Chason Chan for stepping up to represent our team.

On immediate practical matters: I will continue to handle the Pike release, along with our release team, while Petr will be organising the PTG in Denver, and the Pike release deliverables. I will be working closely with Petr over the next couple of weeks to ensure he has all the tools he needs to serve as your PTL.

Congratulations :)

Alex

From: Kendall Nelson kennelson11@gmail.com
Reply-To: "OpenStack Development Mailing List (not for usage questions)" openstack-dev@lists.openstack.org
Date: Thursday, August 17, 2017 at 1:25 AM
To: "OpenStack Development Mailing List (not for usage questions)" openstack-dev@lists.openstack.org
Subject: [openstack-dev] [all][elections] Project Team Lead Election Conclusion and Results

Hello Everyone!

Thank you to the electorate, to all those who voted and to all candidates who put their name forward for Project Team Lead (PTL) in this election. A healthy, open process breeds trust in our decision making capability thank you to all those who make this process possible.

Now for the results of the PTL election process, please join me in extending congratulations to the following PTLs:

  • Barbican : Dave McCowan

  • Chef OpenStack : Samuel Cassiba

  • Cinder : Jay Bryant

  • Cloudkitty : Christophe Sauthier

  • Congress : Eric Kao

  • Designate : Graham Hayes

  • Documentation : Petr Kovar

  • Dragonflow : Omer Anson

  • Ec2 Api : Andrey Pavlov

  • Freezer : Saad Zaher

  • Glance : Brian Rosmaita

  • Heat : Rico Lin

  • Horizon : Ying Zuo

  • I18n : Frank Kloeker

  • Infrastructure : Clark Boylan

  • Ironic : Dmitry Tantsur

  • Karbor : Chenying Chenying

  • Keystone : Lance Bragstad

  • Kolla : Michal Jastrzebski

  • Kuryr : Antoni Segura Puimedon

  • Magnum : Spyros Trigazis

  • Manila : Ben Swartzlander

  • Mistral : Renat Renat

  • Monasca : Witold Bedyk

  • Murano : Zhurong Zhurong

  • Neutron : Kevin Benton

  • Nova : Matt Riedemann

  • Octavia : Michael Johnson

  • OpenStackAnsible : Jean-Philippe Evrard

  • OpenStackClient : Dean Troyer

  • OpenStack Charms : James Page

  • Oslo : ChangBo Guo

  • Packaging Rpm : Thomas Bechtold

  • Puppet OpenStack : Mohammed Naser

  • Quality Assurance : Andrea Frittoli

  • Rally : Andrey Kurilin

  • RefStack : Chris Hoge

  • Release Management : Sean McGinnis

  • Requirements : Matthew Thode

  • Sahara : Telles Mota Vidal Nóbrega

  • Searchlight : Steve McLellan

  • Security : Luke Hinds

  • Senlin : RUIJIE YUAN

  • Shade : Monty Taylor

  • Solum : Zhurong Zhurong

  • Stable Branch Maintenance : Tony Breeds

  • Storlets : Kota Tsuyuzaki

  • Swift : John Dickinson

  • Tacker : Gongysh Gongysh

  • Telemetry : Gordon Chung

  • Tricircle : Zhiyuan Cai

  • Tripleo : Alex Schultz

  • Trove : Amrith Kumar

  • Vitrage : Ifat Afek

  • Watcher : Alexander Chadin

  • Winstackers : Claudiu Belu

  • Zaqar : Feilong Wang

  • Zun : Hongbin Lu

Elections:

Election process details and results are also available here: https://governance.openstack.org/election/

Thank you to all involved in the PTL election process,

[openstack-dev] [docs][ptg] Doc team attendance

Hi everyone,

I’ve updated the docs PTG etherpad with a few details: https://etherpad.openstack.org/p/denver-doc-PTG

All those attending, could you please put your names/availability on the etherpad.

Also – to those interested who cannot attend on the Mon-Tues for Queens planning sessions, please note that I have booked Wednesday morning in Colorado Ballroom C for migration-specific discussions. See: https://ethercalc.openstack.org/Queens-PTG-Discussion-Rooms

If you wish to attend these sessions, please put your name in the Wednesday slot in the etherpad.

Cheers,

Alex


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

[openstack-dev] [docs][i18n][ptg] Denver PTG Summary for Docs (and i18n)

Hi all,

Just wanted to share a few notes and a brief summary of what happened in
Denver last week, during the Project Team Gathering, in docs and i18n
shared sessions.

We had a fairly good attendance of 5 to 15 ppl during the first two
days. A number of people primarily working on other projects showed up in
our sessions to chat about common issues and plans. On the other hand, many
of our cores couldn't attend, though I'm hoping if PTG comes closer to
Europe, the attendance will improve.

On a related note, we also welcomed new cores to the team and the Denver
PTG was an opportunity for some of us to meet face to face for the first
time.

The overall schedule for all our sessions with some comments can be found at
https://etherpad.openstack.org/p/docs-i18n-ptg-queens, there's also
https://etherpad.openstack.org/p/doc-future-problems with a more detailed
discussion of some of the items.

To summarize what I found most important:

VISION

We spent a lot of time discussing a new vision document for the docs team,
based on the updated docs team mission statement
(https://review.openstack.org/#/c/499556/). A working draft is available
here:

https://etherpad.openstack.org/p/docs-i18n-ptg-queens-mission-statement

In the coming weeks, we'll transform those notes into a final draft and
share it with the broader community for input.

The next step after this would be to update/rework
https://governance.openstack.org/tc/reference/tags/docs_follows-policy.html.

EOL DOCS AVAILABILITY

Discussed addressing numerous issues related to publishing EOL docs and our
docs retention policy, based on community feedback and many requests. The
plan is to write a retention policy docs spec, resurrect Mitaka docs and add
badges to clearly identify unsupported content, among other things.

HA GUIDE

Work will continue on the guide per the previous plans.

ARCHITECTURE GUIDE

From Pike, this guide is frozen. Patches still welcome.

OPENSTACK-MANUALS BUGS

To be moved to appropriate projects, if applicable.

CONFIG DOCS

Discussed with several teams, particularly cinder, how to generate
config tables using oslo_config.sphinxext.

REDESIGNING DOCS SITE

A couple of improvements to adjust the site content structure and
overall design was discussed, such as tweaking lists of projects, linking
from series subpages back to the top page, install vs. deployment pages,
linking to projects with no stable branches, redoing our sitemap, switching
to SCSS, improving HTML semantics, etc.

DOCS TOOLING

Doug kindly offered the team and the community to give a presentation
about updated docs tooling:

https://etherpad.openstack.org/p/doc-tool-lunch-and-learn

We'll turn this into a proper doc and share with everybody.

INSTALL GUIDES TESTING

A couple of people and teams showed interest in testing the Pike install
guides (common content + minimal deployment services). To track this
activity, we'll use this wiki page:

https://wiki.openstack.org/wiki/Documentation/PikeDocTesting

TRANSLATIONS

Discussed generating multiple PO files for docs
migrated to project repos, to make translators' lives easier.

THAT'S IT?

Please add to the list if I missed anything important, particularly for
i18n.

Thank you to everybody who attended the sessions, and in particular to Alex
who took most of the notes. I think this PTG was very productive, full of
energy, and intense!

Cheers,
pk


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

[openstack-dev] [doc][meeting] Doc team meeting cancelled today

Hi everyone,

The documentation team meeting is cancelled today as I am unable to host this afternoon due to a conflict,
and Petr is travelling home from the PTG.

The next documentation team meeting will be scheduled in #openstack-meeting at 16:00 UTC, 5 October 2017.

Petr has asked me to mention that he is most likely unable to attend the OpenStack Summit in Sydney.
This means we are looking for volunteers to help present our project update. Is anyone able to help?

Cheers,

Alex


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

[openstack-dev] [docs] Documentation meeting today

Hi all,

The docs meeting will continue today at 16:00 UTC in #openstack-meeting, as
scheduled. For more details, and the agenda, see the meeting page:

https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting

Cheers,
pk


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

[openstack-dev] Thanks for all the fish

Hi everyone,

As most of you know, I was caught up in the Rackspace layoffs that happened earlier this year, and have been looking for work (in between knee surgery) since then. Well, in good news for my bank account, I have now secured a new job with a startup based here in Brisbane. The bad news is that, while it's working on cool stuff and is likely to be at least partially open sourced at some point, there's currently no scope for me to continue working on OpenStack. Sadly, an OpenStack related position just did not come my way, despite my best efforts.

So, this is goodbye for now. I'm going to unsubscribe from the OpenStack mailing lists, and resign my core positions, but you can still email me at this address if you want to. Feel free to hit me up on LinkedIn or Twitter, if that's your thing.

I'm going to miss being part of the community we built here, and all the fabulous people I've met over my OpenStack years. Keep being awesome, I'll be cheering from the sidelines.

Keep on Doc'ing :)

Lana

--
Lana Brindley
Technical Writer
http://lanabrindley.com


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

[openstack-dev] [docs] Documentation meeting Thursday

Hi all,

The docs meeting will continue tomorrow, Thursday at 16:00 UTC in

openstack-meeting, as scheduled. For more details, and the agenda, see the

meeting page:

https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting

Cheers,
pk


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

Below are the meeting minutes from yesterday's docs team meeting.

Because we ran out of time (too many items to cover!), the conversation
about site map automation continued in #openstack-doc after the meeting:

http://eavesdrop.openstack.org/irclogs/%23openstack-doc/%23openstack-doc.2017-10-19.log.html

===========================

openstack-meeting: docteam

===========================

Meeting started by pkovar at 16:01:09 UTC. The full logs are available
at
http://eavesdrop.openstack.org/meetings/docteam/2017/docteam.2017-10-19-16.01.log.html
.

Meeting summary


Meeting ended at 17:00:10 UTC.

Action items, by person


  • mguiney

    • mguiney volunteered to help with sitemap automation, thanks
  • pkovar

    • pkovar to initiate a mtg time poll
    • pkovar to add the vision doc to doc contrib guide

People present (lines said)


  • pkovar (93)
  • dhellmann (58)
  • jamesmcarthur (32)
  • eumel8 (8)
  • mguiney (8)
  • bsilverman (7)
  • openstack (4)
  • thingee (1)

Generated by MeetBot_ 0.1.4


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

[openstack-dev] [docs] Docs meeting time? (was: Documentation meeting Thursday)

Chason,

Thanks for bringing this up. I definitely don't want contributors from Asia
to feel excluded. We discussed it in the docs meeting yesterday and it's
clear that finding a meeting time that would work for Asia, Europe and
America is a bit difficult, to say the least.

Anyhow, I went ahead and I set up a poll to better understand what are
people's preferences wrt meeting time:

http://whenisgood.net/qtqbz52

All, if you could indicate your time preference, that would be appreciated.

Results will appear here:

http://whenisgood.net/qtqbz52/results/ptgfrap

Thanks,
pk

On Thu, 19 Oct 2017 20:47:12 +0800
Chason chason.chan@foxmail.com wrote:

Hi Petr,

Is there any chance the meeting could be moved earlier one so Asian can make it?
Thursday at 16:00 UTC is Friday at 1:00 here.

Thanks,

Chason

在 2017年10月19日,下午8:00,openstack-docs-request@lists.openstack.org 写道:

Send OpenStack-docs mailing list submissions to
openstack-docs@lists.openstack.org

To subscribe or unsubscribe via the World Wide Web, visit
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
or, via email, send a message with subject or body 'help' to
openstack-docs-request@lists.openstack.org

You can reach the person managing the list at
openstack-docs-owner@lists.openstack.org

When replying, please edit your Subject line so it is more specific
than "Re: Contents of OpenStack-docs digest..."

Today's Topics:

  1. [docs] Documentation meeting Thursday (Petr Kovar)

Message: 1
Date: Wed, 18 Oct 2017 15:07:39 +0200
From: Petr Kovar pkovar@redhat.com
To: openstack-docs@lists.openstack.org
Cc: openstack-dev@lists.openstack.org
Subject: [OpenStack-docs] [docs] Documentation meeting Thursday
Message-ID: 20171018150739.28a243fd1691f243c3002da1@redhat.com
Content-Type: text/plain; charset=US-ASCII

Hi all,

The docs meeting will continue tomorrow, Thursday at 16:00 UTC in

openstack-meeting, as scheduled. For more details, and the agenda, see the meeting page:

https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting

Cheers,
pk


Subject: Digest Footer


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

End of OpenStack-docs Digest, Vol 64, Issue 9



OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


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

Thanks for voting, everybody. There is a strong preference to move the
meeting time to 16:00 UTC Mon or Wed, which seems to work for everybody
who voted.

Let's have our next week's docs meeting on Wednesday, 1st November, 16:00
UTC and see how that goes. If you have any objections, please let me know.

Cheers,
pk

On Fri, 20 Oct 2017 18:33:46 +0200
Petr Kovar pkovar@redhat.com wrote:

Chason,

Thanks for bringing this up. I definitely don't want contributors from Asia
to feel excluded. We discussed it in the docs meeting yesterday and it's
clear that finding a meeting time that would work for Asia, Europe and
America is a bit difficult, to say the least.

Anyhow, I went ahead and I set up a poll to better understand what are
people's preferences wrt meeting time:

http://whenisgood.net/qtqbz52

All, if you could indicate your time preference, that would be appreciated.

Results will appear here:

http://whenisgood.net/qtqbz52/results/ptgfrap

Thanks,
pk

On Thu, 19 Oct 2017 20:47:12 +0800
Chason chason.chan@foxmail.com wrote:

Hi Petr,

Is there any chance the meeting could be moved earlier one so Asian can make it?
Thursday at 16:00 UTC is Friday at 1:00 here.

Thanks,

Chason

在 2017年10月19日,下午8:00,openstack-docs-request@lists.openstack.org 写道:

Send OpenStack-docs mailing list submissions to
openstack-docs@lists.openstack.org

To subscribe or unsubscribe via the World Wide Web, visit
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
or, via email, send a message with subject or body 'help' to
openstack-docs-request@lists.openstack.org

You can reach the person managing the list at
openstack-docs-owner@lists.openstack.org

When replying, please edit your Subject line so it is more specific
than "Re: Contents of OpenStack-docs digest..."

Today's Topics:

  1. [docs] Documentation meeting Thursday (Petr Kovar)

Message: 1
Date: Wed, 18 Oct 2017 15:07:39 +0200
From: Petr Kovar pkovar@redhat.com
To: openstack-docs@lists.openstack.org
Cc: openstack-dev@lists.openstack.org
Subject: [OpenStack-docs] [docs] Documentation meeting Thursday
Message-ID: 20171018150739.28a243fd1691f243c3002da1@redhat.com
Content-Type: text/plain; charset=US-ASCII

Hi all,

The docs meeting will continue tomorrow, Thursday at 16:00 UTC in

openstack-meeting, as scheduled. For more details, and the agenda, see the meeting page:

https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting

Cheers,
pk


Subject: Digest Footer


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

End of OpenStack-docs Digest, Vol 64, Issue 9



OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs


OpenStack-docs mailing list
OpenStack-docs@lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

--
Petr Kovar
Sr. Technical Writer | Customer Content Services
Red Hat Czech, Brno


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