Skip to content

Commit a3e3eeb

Browse files
authored
update blog menu and files (knative#4783)
* update blog menu and files Signed-off-by: Carlos Santana <[email protected]> * addressed review comments Signed-off-by: Carlos Santana <[email protected]>
1 parent 8084e65 commit a3e3eeb

26 files changed

+86410
-22
lines changed

.wokeignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
vendor/*
22
third_party/*
33
*-lock.json
4+
*.svg

blog/README.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,15 @@ The Knative website has a basic, top-level navigation that looks like this:
55
```yaml
66
nav:
77
- Home:
8-
- Getting started:
8+
- Tutorial:
99
- Installing:
1010
- Serving:
1111
- Eventing:
1212
- Code samples:
1313
- Reference:
14+
- Community:
1415
- About:
1516
- Blog:
16-
- Case studies:
17-
- Community:
1817
```
1918
2019
Currently, we maintain two different copies of the navigation.
@@ -24,25 +23,26 @@ Currently, we maintain two different copies of the navigation.
2423
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:
2524

2625
```yaml
27-
- Getting started:
26+
- Tutorial:
2827
- Knative Quickstart: getting-started/README.md
2928
- Using Knative Serving:
3029
- First Knative Service: getting-started/first-service.md
3130
- Scaling to Zero: getting-started/first-autoscale.md
3231
- Traffic Splitting: getting-started/first-traffic-split.md
3332
```
3433

35-
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`
34+
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`
3635

37-
The Blog and Community pages instead use absolute links to their sections:
36+
The Blog pages instead use absolute links to its sections:
3837

3938
```yaml
39+
- About:
40+
- Testimonials: about/testimonials.md
41+
- Case studies:
42+
- deepc: about/case-studies/deepc.md
43+
- Outfit7: about/case-studies/outfit7.md
44+
- Puppet: about/case-studies/puppet.md
4045
- Blog: /blog/
41-
- Case Studies:
42-
- deepc: about/case-studies/deepc.md
43-
- Outfit7: about/case-studies/outfit7.md
44-
- Puppet: about/case-studies/puppet.md
45-
- Community: /community/
4646
```
4747

4848
Note that the Blog link is `/blog/` and not `blog/` (and similar for the community site).
@@ -56,29 +56,28 @@ In order to do this, we essentially have a separate mkdocs site for the blog tha
5656
```yaml
5757
nav:
5858
- Home: /docs/
59-
- Getting started: /docs/getting-started/
59+
- Tutorial: /docs/getting-started/
6060
- Installing: /docs/install/
6161
- Serving: /docs/serving/
6262
- Eventing: /docs/eventing/
6363
- Code samples: /docs/samples/
6464
- Reference: /docs/reference/
65-
- About: /docs/about/
65+
- Community: /docs/community/
66+
- About: /docs/about/testimonials
6667
- Blog:
6768
- index.md
6869
- Releases:
6970
- releases/announcing-knative-v0-26-release.md
7071
- releases/announcing-knative-v0-25-release.md
7172
- releases/announcing-knative-v0-24-release.md
7273
...
73-
- Case studies: /docs/about/case-studies/deepc
74-
- Community: /community/
7574
```
7675

7776
A couple of key points:
7877

79-
* The basic, high-level sections are the same as for the main site (Home, Getting started, etc.).
78+
* The basic, high-level sections are the same as for the main site (Home, Tutorial, etc.).
8079

81-
* 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.
80+
* 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.
8281

8382
* For the blog, we use relative links, with `docs/blog/docs/` as the present working directory.
8483

@@ -90,7 +89,7 @@ When a new blog post is created, it will also need to be added to the blog navig
9089

9190
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`.
9291

93-
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`)
92+
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`)
9493

9594
## Common files between main site and blog, also known as non nav.yml files
9695

blog/config/nav.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
nav:
22
- Home: /docs/
3-
- Getting started: /docs/getting-started/
3+
- Tutorial: /docs/getting-started/
44
- Installing: /docs/install/
55
- Serving: /docs/serving/
66
- Eventing: /docs/eventing/
77
- Code samples: /docs/samples/
88
- Reference: /docs/reference/
9-
- "Community": /docs/community/
10-
- About: /docs/about/testimonials
9+
- Community: /docs/community/
10+
- About: /docs/about/testimonials/
1111
#####################################################
1212
# Blog
1313
#####################################################

0 commit comments

Comments
 (0)