Skip to content

Add prerequisites doc#376

Open
WizardBit wants to merge 1 commit intocanonical:mainfrom
WizardBit:create-prereq
Open

Add prerequisites doc#376
WizardBit wants to merge 1 commit intocanonical:mainfrom
WizardBit:create-prereq

Conversation

@WizardBit
Copy link
Copy Markdown
Contributor

Moving "Juju Controller" and "Tunnel into the undercloud network" from the OpenStack Tutorial into their own prerequisites doc. This would make it easier to reference to in other tutorials.

I also added some formatting to the existing markdown.

Comment thread docs/user-docs/openstack/tutorial.md Outdated
Comment thread docs/user-docs/prerequisites.rst
@WizardBit
Copy link
Copy Markdown
Contributor Author

@pponnuvel To render the pages correctly you'll have to pull this PR locally and build the documentation.

cd docs/
make run

http://127.0.0.1:8000/user-docs/prerequisites/
http://127.0.0.1:8000/user-docs/openstack/tutorial/

image

@pponnuvel
Copy link
Copy Markdown
Member

@pponnuvel To render the pages correctly you'll have to pull this PR locally and build the documentation.

cd docs/
make run

http://127.0.0.1:8000/user-docs/prerequisites/ http://127.0.0.1:8000/user-docs/openstack/tutorial/

image

What I meant is that, when looking at the doc from GH itself, the link isn't working:

https://github.com/WizardBit/stsstack-bundles/blob/0c1f65674b50a63c79448ddfe8383f49a4251ff9/docs/user-docs/openstack/tutorial.md

I suspect this is because the GH renderer doesn't recognise the link without the extension.

@WizardBit
Copy link
Copy Markdown
Contributor Author

@pponnuvel I added the static link to the file. The build action for link check failed as it does not exists yet until the PR is merged.

Copy link
Copy Markdown
Member

@pponnuvel pponnuvel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - Thanks @WizardBit

@nicolasbock
Copy link
Copy Markdown
Contributor

Readthedocs builds the PR, you can check it out there: https://canonical-stsstack-bundles--376.com.readthedocs.build/en/376/

Juju controller
---------------

Get a juju controller on ``Serverstack`` (the undercloud).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is serverstack still up? I like the refactoring of the instructions, but we should follow up with updating where to deploy. Most of us are probably using PS7 now.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought serverstack was just referencing any server as this repo is public.

Comment thread docs/user-docs/openstack/tutorial.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants