You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* update blog menu and files
Signed-off-by: Carlos Santana <[email protected]>
* addressed review comments
Signed-off-by: Carlos Santana <[email protected]>
Copy file name to clipboardExpand all lines: blog/README.md
+17-18Lines changed: 17 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -5,16 +5,15 @@ The Knative website has a basic, top-level navigation that looks like this:
5
5
```yaml
6
6
nav:
7
7
- Home:
8
-
- Getting started:
8
+
- Tutorial:
9
9
- Installing:
10
10
- Serving:
11
11
- Eventing:
12
12
- Code samples:
13
13
- Reference:
14
+
- Community:
14
15
- About:
15
16
- Blog:
16
-
- Case studies:
17
-
- Community:
18
17
```
19
18
20
19
Currently, we maintain two different copies of the navigation.
@@ -24,25 +23,26 @@ Currently, we maintain two different copies of the navigation.
24
23
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:
25
24
26
25
```yaml
27
-
- Getting started:
26
+
- Tutorial:
28
27
- Knative Quickstart: getting-started/README.md
29
28
- Using Knative Serving:
30
29
- First Knative Service: getting-started/first-service.md
31
30
- Scaling to Zero: getting-started/first-autoscale.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`
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`
36
35
37
-
The Blog and Community pages instead use absolute links to their sections:
36
+
The Blog pages instead use absolute links to its sections:
38
37
39
38
```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
40
45
- 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/
46
46
```
47
47
48
48
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
56
56
```yaml
57
57
nav:
58
58
- Home: /docs/
59
-
- Getting started: /docs/getting-started/
59
+
- Tutorial: /docs/getting-started/
60
60
- Installing: /docs/install/
61
61
- Serving: /docs/serving/
62
62
- Eventing: /docs/eventing/
63
63
- Code samples: /docs/samples/
64
64
- Reference: /docs/reference/
65
-
- About: /docs/about/
65
+
- Community: /docs/community/
66
+
- About: /docs/about/testimonials
66
67
- Blog:
67
68
- index.md
68
69
- Releases:
69
70
- releases/announcing-knative-v0-26-release.md
70
71
- releases/announcing-knative-v0-25-release.md
71
72
- releases/announcing-knative-v0-24-release.md
72
73
...
73
-
- Case studies: /docs/about/case-studies/deepc
74
-
- Community: /community/
75
74
```
76
75
77
76
A couple of key points:
78
77
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.).
80
79
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.
82
81
83
82
* For the blog, we use relative links, with `docs/blog/docs/` as the present working directory.
84
83
@@ -90,7 +89,7 @@ When a new blog post is created, it will also need to be added to the blog navig
90
89
91
90
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`.
92
91
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`)
94
93
95
94
## Common files between main site and blog, also known as non nav.yml files
0 commit comments