[rdo-list] [Docs] "Quickstart" in our documentation

John Fulton johfulto at redhat.com
Fri Jun 9 21:22:33 UTC 2017


On Fri, Jun 9, 2017 at 1:16 PM, Rich Bowen <rbowen at redhat.com> wrote:
> On 06/09/2017 01:11 PM, Alan Pevec wrote:
>>> * Packstack: For an all-in-one proof of concept cloud
>>> * TripleO Quickstart: (How do we want to advertise this?)
>>> * TripleO.org: For actual real-world production deployments
>>
>>> Yes? Comments?
>>
>> Yes! I liked the wording in
>> https://github.com/redhat-openstack/website/issues/924#issuecomment-306765031
>> let's start with that:
>>
>> Spin up an all-in-one concept cloud with Packstack (links to packstack page)
>> Deploy a production cloud with the TripleO (links to tripleo.org)
>> Develop and Test OpenStack with the TripleO Quickstart tool (links to
>> tripleoQS page)
>
> That change is already in place on the front page. So I was looking for
> further buy-in before we make broader changes across the site.

+1

>> I would just drop tool names, since in the future we might come up
>> with different tooling for each use-case:
>>
>> Spin up an all-in-one concept cloud (links to packstack page)
>> Deploy a production cloud (links to tripleo.org)
>> Develop and test OpenStack (links to tripleoQS page)
>>
>
> And #931 also involves changing the URL path to reflect this new
> phrasing, too, which is more involved. As I say in that ticket, I'm a
> big fan of URLs reflecting the way we want people to think about things.
> And our current site is a bit of a jumble when it comes to sane URLs.
>
> Anyways, thanks for the feedback and confirmation. I look forward to
> hearing from others also.

The current versions of https://www.rdoproject.org and
https://www.rdoproject.org/tripleo with the above change look great.

IMO: Decoupling "quickstart" from "packstack" will help the confusion.
If all instances of the word "quickstart" could be replaced by
"packstack" in the following page I think it would help:
https://www.rdoproject.org/install/quickstart

I would even change the URL from /install/quickstart to
/install/packstack and I think /install/quickstart shouldn't even
redirect.

Similarly, I'm all for removing the phrase "packstack quickstart" from
https://www.rdoproject.org/install .

Thanks,
  John




More information about the dev mailing list