update blog menu and files (#4783)

* update blog menu and files

Signed-off-by: Carlos Santana <csantana23@gmail.com>

* addressed review comments

Signed-off-by: Carlos Santana <csantana23@gmail.com>
This commit is contained in:
Carlos Santana 2022-02-25 05:37:42 -05:00 committed by GitHub
parent 8084e654cb
commit a3e3eebe70
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
26 changed files with 86410 additions and 22 deletions

View File

@ -1,3 +1,4 @@
vendor/*
third_party/*
*-lock.json
*.svg

View File

@ -5,16 +5,15 @@ The Knative website has a basic, top-level navigation that looks like this:
```yaml
nav:
- Home:
- Getting started:
- Tutorial:
- Installing:
- Serving:
- Eventing:
- Code samples:
- Reference:
- Community:
- About:
- Blog:
- Case studies:
- Community:
```
Currently, we maintain two different copies of the navigation.
@ -24,7 +23,7 @@ Currently, we maintain two different copies of the navigation.
The main one, for the website as a whole, is located at [`docs/config/nav.yml`](docs/config/nav.yml) and contains the links for all the subject matter except for the Blog and Community pages. It uses relative links for everything except the Blog / Community, for example:
```yaml
- Getting started:
- Tutorial:
- Knative Quickstart: getting-started/README.md
- Using Knative Serving:
- First Knative Service: getting-started/first-service.md
@ -32,17 +31,18 @@ The main one, for the website as a whole, is located at [`docs/config/nav.yml`](
- Traffic Splitting: getting-started/first-traffic-split.md
```
Note here that each link assumes that the present working directory is `docs/docs/`, so for example the "Getting Started" README which is located in `docs/docs/getting-started/README.md` is listed as `getting-started/README.md`
Note here that each link assumes that the present working directory is `docs/docs/`, so for example the "Tutorial" README which is located in `docs/docs/getting-started/README.md` is listed as `getting-started/README.md`
The Blog and Community pages instead use absolute links to their sections:
The Blog pages instead use absolute links to its sections:
```yaml
- About:
- Testimonials: about/testimonials.md
- Case studies:
- deepc: about/case-studies/deepc.md
- Outfit7: about/case-studies/outfit7.md
- Puppet: about/case-studies/puppet.md
- Blog: /blog/
- Case Studies:
- deepc: about/case-studies/deepc.md
- Outfit7: about/case-studies/outfit7.md
- Puppet: about/case-studies/puppet.md
- Community: /community/
```
Note that the Blog link is `/blog/` and not `blog/` (and similar for the community site).
@ -56,13 +56,14 @@ In order to do this, we essentially have a separate mkdocs site for the blog tha
```yaml
nav:
- Home: /docs/
- Getting started: /docs/getting-started/
- Tutorial: /docs/getting-started/
- Installing: /docs/install/
- Serving: /docs/serving/
- Eventing: /docs/eventing/
- Code samples: /docs/samples/
- Reference: /docs/reference/
- About: /docs/about/
- Community: /docs/community/
- About: /docs/about/testimonials
- Blog:
- index.md
- Releases:
@ -70,15 +71,13 @@ nav:
- releases/announcing-knative-v0-25-release.md
- releases/announcing-knative-v0-24-release.md
...
- Case studies: /docs/about/case-studies/deepc
- Community: /community/
```
A couple of key points:
* The basic, high-level sections are the same as for the main site (Home, Getting started, etc.).
* The basic, high-level sections are the same as for the main site (Home, Tutorial, etc.).
* The blog requires absolute links for all sections not in the blog. For example, the Getting started section link is `/docs/getting-started/` for the blog site (whereas it was simply `getting-started/` for the main site). Also note that for the blog, we don't need to link to a specific file, as each of those directories has a README that gets redirected to.
* The blog requires absolute links for all sections not in the blog. For example, the Tutorial section link is `/docs/getting-started/` for the blog site (whereas it was simply `getting-started/` for the main site). Also note that for the blog, we don't need to link to a specific file, as each of those directories has a README that gets redirected to.
* For the blog, we use relative links, with `docs/blog/docs/` as the present working directory.
@ -90,7 +89,7 @@ When a new blog post is created, it will also need to be added to the blog navig
If a major change to the site navigation is made (for example, adding a new section to the top navigation tabs), then the change will need to be made in both `docs/config/nav.yml` and `docs/blog/config/nav.yml`.
For changes that are not top-level (i.e. adding a subsection to the "Getting started" guide or creating a new category of blog post), the change only needs to be made in the relevant section, as it's invisible to the other (for example, the subsection of the "Getting started" guide only needs to be made in `docs/config/nav.yml`)
For changes that are not top-level (i.e. adding a subsection to the "Tutorial" guide or creating a new category of blog post), the change only needs to be made in the relevant section, as it's invisible to the other (for example, the subsection of the "Tutorial" guide only needs to be made in `docs/config/nav.yml`)
## Common files between main site and blog, also known as non nav.yml files

View File

@ -1,13 +1,13 @@
nav:
- Home: /docs/
- Getting started: /docs/getting-started/
- Tutorial: /docs/getting-started/
- Installing: /docs/install/
- Serving: /docs/serving/
- Eventing: /docs/eventing/
- Code samples: /docs/samples/
- Reference: /docs/reference/
- "Community": /docs/community/
- About: /docs/about/testimonials
- Community: /docs/community/
- About: /docs/about/testimonials/
#####################################################
# Blog
#####################################################

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 388 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 366 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 374 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 366 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 366 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 368 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 368 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 368 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 365 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 366 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 374 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 365 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 366 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 368 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 366 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 368 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 412 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

View File

@ -0,0 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 26.0.2, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
viewBox="0 0 133.4 133.7" style="enable-background:new 0 0 133.4 133.7;" xml:space="preserve">
<style type="text/css">
.st0{fill:#53B3DD;}
</style>
<path class="st0" d="M0,59.5L0,51l20.6,15.8L0,82.6l0-8.5l9.5-7.3L0,59.5z M133.4,59.5l0-8.5l-20.6,15.8l20.5,15.8l0-8.5l-9.5-7.3
L133.4,59.5z M66.7,124l7.3,9.5l8.5,0L66.7,113l-15.8,20.6l8.5,0L66.7,124z M59.4,0.1l-8.5,0l15.8,20.6L82.5,0.1l-8.5,0l-7.3,9.5
L59.4,0.1z M100.6,32.9H32.7v67.9h67.9V32.9z M40.7,40.8h52v52h-52V40.8z M54.4,66.9c0-2.8,0.3-5.2,0.9-7.3c0.6-2.1,1.4-3.8,2.5-5.2
c1.1-1.4,2.3-2.4,3.8-3.1c1.5-0.7,3.1-1,4.9-1c3.9,0,6.8,1.4,8.9,4.1c2.1,2.7,3.1,6.9,3.1,12.6c0,2.8-0.3,5.3-0.9,7.4
c-0.6,2.1-1.4,3.8-2.5,5.2c-1.1,1.4-2.3,2.4-3.8,3.1c-1.5,0.7-3.1,1-4.9,1c-3.9,0-6.9-1.4-8.9-4.3C55.4,76.5,54.4,72.4,54.4,66.9z
M60.4,66.9c0,0.5,0,0.9,0,1.3c0,0.4,0,0.8,0.1,1.3l11.1-10.2c-0.9-2.6-2.6-3.9-5.1-3.9c-1.9,0-3.4,0.9-4.5,2.8
C60.9,60,60.4,63,60.4,66.9z M72.6,66.9c0-0.5,0-1,0-1.4c0-0.4,0-0.9-0.1-1.3L61.3,74.4c0.9,2.8,2.7,4.2,5.1,4.2
c1.9,0,3.4-0.9,4.5-2.8C72,73.9,72.6,71,72.6,66.9z"/>
</svg>

After

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

View File

@ -239,7 +239,7 @@ nav:
- Client: reference/client/README.md
- Concepts:
- Duck types: reference/concepts/duck-typing.md
- "Community":
- Community:
- Welcome to the community: community/README.md
- Contribute to Knative: community/contributing.md
- About the community: community/about.md