canonical / juju.is

The website for juju.is

juju.is

This is the repo for the Juju website.

Usage

Install the dotrun snap, then run:

dotrun

And click on the server link that appears in the server logs.

Run locally with search functionality

If you wish to run the site locally with search enabled, you'll need to pass a key. This key can be obtained from the Google Cloud Platform console, or by contacting #webteam on IRC if you don't have access.

dotrun --env SEARCH_API_KEY={your_key_here}

Deploy

You can find the deployment config in the deploy folder.

juju.is's Issues

[About pages] Mission

https://docs.google.com/document/d/15Xnp-hjoMYguvqlrGzv-sAWw8GlbGfC7MBAJedWTIYU/edit

Dealing with inert credentials link doesn't work

Link following link doesn't work (404 response):

https://juju.is/t/tutorial-managing-credentials/1289#heading--dealing-with-inert-credentials#heading--dealing-with-inert-credentials

Docs, mobile UI overlapping search input over button

There seems to be a button under the input search field, barely visible. Would be enough to align this with the other docs pages (e.g. on maas.io) without button.

Search clear button is misplaced

Firefox 75.0, Chromium 65.0

1. Go to juju.is/docs.
2. Type anything in the search field.

What you see: The clear button is

• 11.3rem from the right edge of the field (.p-search-box__input {padding-right: calc(2 * 2.3rem) + <button style="right: 6.7rem">)
• slightly above the vertical center of the field.

What you should see: The clear button should be

• only a few pixels from the right edge of the field
• vertically centered in the field.

A similarly misplaced clear button appeared on ubuntu.com in January (ubuntu.com#6472).

Logo is off at small screen sizes

Reduce viewport to 500px

Navigation doesn't match anchor on discourse

If you hover over this icon on discourse.juju.is it'll show the link "https://discourse.juju.is" but clicking it takes you to "https://juju.is".

[About pages] Architecture page

https://docs.google.com/document/d/1DfRx28l_xePg2Jx-0VsJc7BM5Oez4L4l_UEdQxQTG1o/edit#

[About pages] High Availability

https://docs.google.com/document/d/1hyW0MSqIc9bS9NMcE6VPpX5f2PAksLUBIC2oU6IRMl0/edit#

Incomplete sentence on https://juju.is/docs/microk8s-cloud

There's an incomplete sentence in this paragraph:

Important concept - clouds registered on the controller vs the client: Clouds are deployment targets. They include credential information. Your controller can be notified of new clouds, allowing

[About pages] Delivering Ops Code Quality

https://docs.google.com/document/d/18_PRa2HA_P1j5JCbhZ0PsTRl9oVUHoeh6dI9u8GqQIs/edit

Ticked icons not the right colour and the "X" in the search is in a strange position

Can't direct a tutorial to be hosted at juju.is/tutorials

I'm in the process of writing a tutorial for the Juju community, but can't figure out how to send it to juju.is/tutorials rather than jaas.ai/tutorials where it currently appears.

Slide show images are too small

The correct sizes and assets can be found in the original issue - #20

[About pages] Operator Lifecycle Manager

https://docs.google.com/document/d/1B0adX3iTzNrF_RORQUWU6MaYn_E2wzvfJYUbolAY3Ok/edit#

Height slightly different between first and other slides in carousel homepage

The first slide of the carousel in the homepage has a slightly different height than the others on the homepage.

[About pages] Operator Lifecycle Manager SAAS

https://docs.google.com/document/d/1zmGR4hZyyTLuPc98XahtcM7Tlb35QYzXZ9dWRf50l8Y/edit

[About pages] Community-driven DevSecOps

https://docs.google.com/document/d/10tjWftKVRrmsUn9R5vSLlRtLS0o0nwBbKA4Av5m840w/edit#

Remove .webcache file and to .gitignore file

The webcache file shouldn't be part of the repo.

Search not working properly

If I go to juju.is/docs and search 'status-set', I get 10 results.

10 different results, pointing to 10 different pages... but somehow 9 of those results all have the same title, "The simplest way to deploy and maintain applications in the ... - Juju".

But, more importantly, in all those 10 pages, the string 'status-set' is NOT THERE.

None of those 10 results pointed me to https://discourse.juju.is/t/hook-tools/1163 (which is where status-set is documented, I later found).

Bugs link refers to GitHub rather than Launchpad

We're currently referring users to a page that isn't being used for bug management by the team.

https://github.com/canonical-web-and-design/juju.is/blob/7eebdeb89254bb8926b241e82c9244a848abe6bb/templates/base.html#L168

The links to the commands on the CMR page all 404

To reproduce click any of the command links here: https://juju.is/docs/cross-model-relations

Add images to the slide show

Please can we add the correct illustrations to the homepage slider. Currently each slide has the Juju logo.

I've saved the images at 534x374 pixels, which is the same as the slider on jaas.ai, so the buttons at the bottom don't jump around.

I'm attaching them as a zip because the assets server seems to crop the size.

juju.is slides.zip

Asset server links in case they can be used:

https://assets.ubuntu.com/v1/06d371ed-slide-appmodeling.svg
https://assets.ubuntu.com/v1/3c6d2c1e-slide-automation.svg
https://assets.ubuntu.com/v1/f2e4e9fb-slide-opensource.svg
https://assets.ubuntu.com/v1/26415d45-slide-simple.svg

@barrymcgee I used the compression plugin, seemed to help a bit 👍

Docs "landing page" is not generated by doc index page

There appears to have been a regression when we moved to the new domain name. Prior to the shift to juju.is, https://juju.is/docs was rendered by https://discourse.juju.is/t/juju-documentation/1087. The page's contents is now fairly old.

[About pages] Universal operators

https://docs.google.com/document/d/1vdT7mA2GlXxad12VbuIx12QtNktbKkjWnkcZd7LJo4A/edit#

dead link as "Dealing with inert credentials"

The link with the text "Dealing with inert credentials" in
https://juju.is/docs/vsphere-cloud#heading--adding-credentials
leads to:
https://juju.is/t/tutorial-managing-credentials/1289#heading--dealing-with-inert-credentials#heading--dealing-with-inert-credentials
but it's 404 Not Found.

Link to Juju commands docs page is broken

The link to Juju commands in the Reference section (https://juju.is/docs/commands) returns 500: Server error encountered - sorry for the inconvenience..

It should display https://discourse.jujucharms.com/t/commands/1667

[About pages] Overview page

https://docs.google.com/document/d/1CSLdRlusY9BilYZ6CrmWeJblNEOWl62VfJh2J1yDfZk/edit

[About pages] Model Driven Operations

https://docs.google.com/document/d/1_NL5GxZgsP6OURWepwBSIuZOKmEzmwaAqnnaRhfJ4lU/edit#

[About pages] OLM Architecture

https://docs.google.com/document/d/1DfRx28l_xePg2Jx-0VsJc7BM5Oez4L4l_UEdQxQTG1o/edit#

Console syntax highlighting in docs pages

Our current syntax highlighting system doesn't distinguish between commands executed on the command line and their output. Compare with GitHub:

$ juju add-machine
created machine 1
$ juju upgrade-series 0 prepare bionic
WARNING: This command will mark machine "0" as being upgraded to series "bionic".
This operation cannot be reverted or canceled once started.
Units running on the machine will also be upgraded. These units include:
  rabbitmq-server/0

Leadership for the following applications will be pinned and not
subject to change until the "complete" command is run:
  rabbitmq-server

Continue [y/N]? y

This makes it very hard to write nicely formatted tutorials.

[Sorry if this is the wrong place to lodge this!]

Update juju.is footer to match jaas.ai

Please can we update the footer to use the one currently on jaas.ai. We may need to change the background colour of the last "Learn more" section, let's see.

This footer will also be used on the Charmhub site to make them all consistent.

[About pages] OLM Architecture

https://docs.google.com/document/d/1DfRx28l_xePg2Jx-0VsJc7BM5Oez4L4l_UEdQxQTG1o/edit

juju.is/docs should explain 500s from Discourse

It'd be helpful if the 500 page for juju.is/docs could give a suitable hint if the 500 was caused by a problem talking to Discourse.

Search control buttons to close together

[About pages] Operator Services

https://docs.google.com/document/d/1_HS6kPV3jxSA0k9d-nr5PFu9V40Nv7d00N5tBwcPmG8/edit#

Side navigation in docs can't be opened on mobile

Side navigation in juju.is/docs gets hidden on mobile, but it can't be expanded. It seems like menu button under search doesn't do anything.

Copy code snippet - remove copy-icon and border

From juju.is, will be proposed on Vanilla as an optional UI element instead of the current one.
Remove the border, leave a white background (on grey) or a grey background if the snippet is on white.

E.g.:

For all, remove the copy icon and copy functionality on click.

[About pages] Integration

https://docs.google.com/document/d/1xbMPHUB-vJ0G-TIozCarZXPDqhbQgf1EQb2lQlv6-3s/edit#

[About pages] History page

New testimonal - Sean Shüping

Am not sure if this is the correct place for this, but community member Sean Shüping has provided this testimonial for us to use:

For me, speed and simplicity are paramount. It may sound silly, but a lot of the stuff I do in my lab with Juju is out of pure laziness. Juju frees my brain to focus on other things.

While Juju itself is really intuitive and easy to use, I was pleasantly surprised by how welcoming and humble the Juju community is. The community is a big reason why I’ve stuck with it.

Please include a link to his business website devzero.co.za if/when this goes up.

Update the strip background colour

Can we update the p-strip--light background colour from #F7F7F7 to #F0F5F7 to match jaas.ai. Looks like it's called p-strip--accent on jaas.ai

Thanks.

Convert to flask application

Collapsible navigation in docs

The Juju documentation is extensive. And, yet it has gaps. We would like to continue to expand it, but are worried about nesting navigation too deeply.

Would it be possible to toggle the visibility of (sub-)sections?

Multistage builds for juju.is

Summary

• Multistage builds to decrease image size, faster image building.
• Update .dockerignore to ignore files uncessary in prod
• Update image to Ubuntu Focal

link to help-google doesn't work

is listed in wizard for running deployment
https://jujucharms.com/docs/stable/help-google

Under "setting up GCE credentials"

Ability to pin tutorials to the top or to rank the default tutorial order

I would like to be able to pin introductory tutorials to the top of juju.is/tutorials. That way new users don't get confused by needing to scan through lots of advanced, mostly irrelevant, material.

Staging environment for tutorials

Is it possible to set up a staging environment for viewing how draft tutorials are rendered on juju.is/tutorials before they're published?

[About pages] Multi Cloud Operations

https://docs.google.com/document/d/1NsFdr1yCMECGCA4qwLQGzDpQ6xYlLMRYbhOjW_EP9LU/edit#

Remove _status file

_status file seems something that comes from jekyll.
Talisker already handles that

Every docs page has the title "Juju - The simplest way to deploy and maintain applications in the cloud"

Every document within docs has the same title. Although it's parameterised within the template, it looks like something's not set correctly..

https://github.com/canonical-web-and-design/juju.is/blob/fb98983e0c9a0037b497ac540330714a999ebde3/templates/docs/base.html#L4

Related issue juju/docs#3482