metal3-io / metal3-io.github.io Goto Github PK

Is this a BUG REPORT or FEATURE REQUEST?:

/kind bug

What happened:
The google UA parameter shouldn't be hardcoded in the head.html
What you expected to happen:
It should be a variable in the _config
Anything else we need to know?: no

Seems that categories defined in article got an extra "/" at the end that causes htmlproofer to detect link as broken

When entering an article, to read another one is needed to go back to webpage, scroll down, click on the next one.

Is it possible a next/back to read related ones?

I think it would be nice if there is some document on how to deploy metal3 in a vanilla k8s cluster. The try-it doc is great but it 'hides' the procedure in the 03 script.

The circle around the twitter image on a page like https://metal3.io/blog/2019/09/11/Baremetal-operator.html is much much larger than the icon itself when viewed in Safari on macOS 10.14.6.

It looks like the CI jobs run some validation against the content. It would be nice to know how to run those locally before creating a pull request.

https://www.dareboost.com/en/report/d_15d773f2190b99843ddb4b550?reportIds=d_15d773f2190b99843ddb4b550

https://www.dareboost.com/en/report/d_15d773f2190b99843ddb4b550?reportIds=d_15d773f2190b99843ddb4b550

We have the code, just need the account info.

As @matthewcarleton commented, have pygments moved to scss compiled into one stylesheet.

Related with #26

Controller is title2 but not properly seen as different from text

Looks a bit 'strange'

Text too small:

Clickable elements too close:

Content wider than screen:

How can we include 'links' in FAQ? with regular markdown formatting it doesn't work and text is hidden

Related with #36 when article has category in capital letters, it fails as the category doesn't exist

The "related entries" inside of a post in the left side looks squeezed all together.
Some space should be added between each entry.

Example: https://deploy-preview-114--metal3.netlify.com/blog/2019/05/13/the_new_stack_metal3_uses_openstack_ironic_for_declarative_bare_metal_kubernetes

All links to the design documents in https://github.com/metal3-io/metal3-docs are broken in _include/docs.md. Maybe you planing to move them to this repo instead or just add the url to the metal3-docs repo.
Anyway, thanks for updating the documentation. :-)

Just saw yesterday this introduction to Metal3 along with Operators, CRDs, actuators, controllers and Ironic at ShiftDev2019. IMHO looks like a good basic introduction of the components inside metal3.

Here is the link: https://www.youtube.com/watch?v=iHlaimz48vg&t=8s

Probably good to include it in the conference talks section.

When in an article, like in #31 it would be good to additionally have a sidebar of related articles to navigate

Currently in categories listing: https://metal3.io/blog/categories.html#kubernetes

Articles are not itemized nor idented

Can we ensure that 'www' also redirects to the metal3.io domain we do use?

We're not referencing it but some users tend to use it and would be good to have it.

Populate https://www.youtube.com/channel/UC_xneeYbo-Dl4g-U78xW15g with videos and include the link on the website.

Related with #124

Usually when setting:

api: patata

the output is rendered using different 'inks' based on the format specified, which allows to easily read through the code provided (bash, yaml, python, go, etc)

The output on the webpage is always grey

/kind bug

What happened:
The meta tags created for the ogps are different, some of them have the close char at the end, other don't, as it is html we can avoid the closing char '/':

What you expected to happen:
References: https://www.w3schools.com/tags/tag_meta.asp

Anything else we need to know?:
Check all the includes to let it clean.

References: https://www.w3schools.com/tags/tag_meta.asp

Even with latest 'master', there's still a text box as described initially in #41 and appearing for example in screenshoot at #51

I suggest to add @maelk talk at Cloud Native Nordics meetup as content in our blog:

• Prepare a blog post which includes Youtube link, demo's showns as videos (@maelk already has the asciinema) and elaborated content.
• Add a link in the same blog post to the slides presented. Probably a link to a public repository (gdrive or similar) or depending on the size, we could consider add it in this repo or metal3-docs. This is open to discussion.

https://www.dareboost.com/en/report/d_15d773f2190b99843ddb4b550?reportIds=d_15d773f2190b99843ddb4b550

Would be good to have the PR's tagged with 'kind/blog' for PR's with files in the _post/ path

Instead of providing a list of links, we could create small blog posts linking to each of the articles. Maybe not one per article, since several of them were on the same day.

As community meetings are starting I would like to find that info in the resources webpage:

• Calendar
• zoom link
• regularity

https://github.com/metal3-io/metal3-io.github.io/blob/master/_includes/try-it.md

• Plain commands looks ok the first time, then they look weird (like many tabs):
  

• It is not clear if v1alpha2 supports adding nodes to the running clusters or if that's v1alpha1 feature only

• No instructions on how to manage the cluster created with v1alpha2 (such as getting the kubeconfig file, how to see the nodes, etc.)

• Nodes in the cluster created with v1alpha2 are 'not ready' because there is no SDN deployed. I think it would be nice to include a default one (calico for instance)

• Another 'minor issue' would be there is no 'go to top' which means you need to scroll all the way up to see the index/header

• The NUM_NODES variable is used to create nodes in the cluster. It would be nice to add that variable to the try-it guide in case you want to create more nodes to play with the machine object (like scale up/down)

Currently 'metal3.io' goes to http and it should redirect to https instead. Also if you keep browsing the web, it sticks with http protocol.

vs

The titles of blog posts on https://metal3.io/blog/index.html are styled in the same way as the "read more" links, which makes me think I should be able to click on them. Can we make the titles links and replace the "read more" links?

While working on #25 , the titles displayed for regular 'markdown' formatting are not properly differentiated from regular text:

Source code for markdown is at that PR (#25) that also 'reenables' blogs section on index.html and removes the sample articles

The first line of all of the pre-formatted code blocks is always indented 1 extra space compared to the rest of the lines when viewed in Safari on macOS 10.14.6. This can make YAML examples appear invalid. For example, from https://metal3.io/blog/2019/09/11/Baremetal-operator.html :

https://www.dareboost.com/en/report/d_15d773f2190b99843ddb4b550?reportIds=d_15d773f2190b99843ddb4b550

We would like to get fontawesome included in the documents as it is likely to be needed when we cover admonitions in the articles.

Once the content has been added tests need to be done for the search feature and the social media share feature.

From travis execution:

- ./_site/404.html
  *  internally linking to icon.png, which does not exist (line 11)
     <link rel="apple-touch-icon" href="icon.png">
  *  internally linking to site.webmanifest, which does not exist (line 10)
     <link rel="manifest" href="site.webmanifest">
- ./_site/blog/categories.html
  *  internally linking to icon.png, which does not exist (line 11)
     <link rel="apple-touch-icon" href="icon.png">
  *  internally linking to site.webmanifest, which does not exist (line 10)
     <link rel="manifest" href="site.webmanifest">
- ./_site/blog/index.html
  *  internally linking to icon.png, which does not exist (line 11)
     <link rel="apple-touch-icon" href="icon.png">
  *  internally linking to site.webmanifest, which does not exist (line 10)
     <link rel="manifest" href="site.webmanifest">
- ./_site/community-resources.html
  *  internally linking to icon.png, which does not exist (line 11)
     <link rel="apple-touch-icon" href="icon.png">
  *  internally linking to site.webmanifest, which does not exist (line 10)
     <link rel="manifest" href="site.webmanifest">
- ./_site/documentation.html
  *  image assets/images/infograph-stack.svg does not have an alt attribute (line 140)
  *  internally linking to icon.png, which does not exist (line 11)
     <link rel="apple-touch-icon" href="icon.png">
  *  internally linking to site.webmanifest, which does not exist (line 10)
     <link rel="manifest" href="site.webmanifest">�[0m
- ./_site/index.html
  *  image /assets/images/home-left-image.svg does not have an alt attribute (line 78)
  *  image /assets/images/home-right-image.svg does not have an alt attribute (line 79)
  *  internally linking to icon.png, which does not exist (line 11)
     <link rel="apple-touch-icon" href="icon.png">
  *  internally linking to site.webmanifest, which does not exist (line 10)
     <link rel="manifest" href="site.webmanifest">
- ./_site/privacy-statement.html
  *  internally linking to icon.png, which does not exist (line 11)
     <link rel="apple-touch-icon" href="icon.png">
  *  internally linking to site.webmanifest, which does not exist (line 10)
     <link rel="manifest" href="site.webmanifest">
- ./_site/test-cat-2/2019/06/30/second-post.html
  *  internally linking to icon.png, which does not exist (line 11)
     <link rel="apple-touch-icon" href="icon.png">
  *  internally linking to site.webmanifest, which does not exist (line 10)
     <link rel="manifest" href="site.webmanifest">
  *  linking to /blog/categories.html#test-cat-2/, but test-cat-2/ does not exist (line 83)
     <a class="mk-blog-meta__item mk-blog-meta__category" href="/blog/categories.html#test-cat-2/">
    test-cat-2
  </a>
- ./_site/test-cat/2019/06/30/first-post.html
  *  internally linking to icon.png, which does not exist (line 11)
     <link rel="apple-touch-icon" href="icon.png">
  *  internally linking to site.webmanifest, which does not exist (line 10)
     <link rel="manifest" href="site.webmanifest">
  *  linking to /blog/categories.html#test-cat/, but test-cat/ does not exist (line 83)
     <a class="mk-blog-meta__item mk-blog-meta__category" href="/blog/categories.html#test-cat/">
    test-cat
  </a>
- ./_site/try-it.html
  *  internally linking to icon.png, which does not exist (line 11)
     <link rel="apple-touch-icon" href="icon.png">
  *  internally linking to site.webmanifest, which does not exist (line 10)
     <link rel="manifest" href="site.webmanifest">

Seems that we define 'favicon' which is later not included