Simple clean up of documentation. #849

photong · 2019-11-22T04:42:12Z

This is the first step of the documentation clean up.

Keats

Looks amazing, thanks a lot!
I have a few comments on it but nothing major

Keats · 2019-11-25T11:26:34Z

docs/content/documentation/content/image-processing/index.md

@@ -50,7 +50,7 @@ The function returns a full URL to the resized image.

 ## Resize operations

-The source for all examples is this 300 × 380 pixels image:
+The source for all examples is this 300 pixel × 380 pixel image:


is 300x380 pixels not more correct than 300 pixel x 380 pixel? No s on pixel?

Here, "pixel" is an adjective. Similar to "3-meter-tall building" (not "3-meters-tall building"). I omitted "-" here because "300-pixel x 380-pixel image" is difficult to read.

Keats · 2019-11-25T11:31:57Z

docs/content/documentation/content/image-processing/index.md

@@ -118,7 +121,7 @@ The `resize_image()` can be used multiple times and/or in loops. It is designed

 This can be used along with `assets` [page metadata](@/documentation/templates/pages-sections.md) to create picture galleries.
 The `assets` variable holds paths to all assets in the directory of a page with resources
-(see [assets colocation](@/documentation/content/overview.md#assets-colocation)): if you have files other than images you
+(see [asset co-location](@/documentation/content/overview.md#asset-co-location)); if you have files other than images you


I think both spelling are correct (at least according to Wikipedia: https://en.wikipedia.org/wiki/Colocation_centre) and not changing it means that links to it will still work.

Yes, you are right. There is also "collocation" (older word). Please see https://www.grammarphobia.com/blog/2013/08/collocation-colocation-co-location.html for a long discussion if interested. I just thought "co-location" is a bit easier to read (I think I fixed the links too). I'm ok with colocation, so please revert this change.

Keats · 2019-11-25T11:36:05Z

docs/content/documentation/content/linking.md


 ## Anchor insertion
-It is possible to have Zola automatically insert anchor links next to the heading, as you can see on the site you are currently
-reading if you hover a title.
+It is possible to have Zola automatically insert anchor links next to the heading, as you can see on this site


site -> documentation?

I see. "site your are currently reading" = "this documentation". Please make this change.

Keats · 2019-11-25T11:38:12Z

docs/content/documentation/content/overview.md


-## Assets colocation
+## Asset co-location


same as above, I'm not sure breaking the links is worth it if they are both correct

I agree. Please revert.

Keats · 2019-11-25T11:45:03Z

docs/content/documentation/content/page.md


-```toml
+```TOML


those are markers for the syntax highlighter, I don't think we want to change them as they usually work by matching the file extension.

Sorry, I didn't notice that "toml" will not show up in the output. Please revert.

Keats · 2019-11-25T11:52:15Z

docs/content/documentation/getting-started/cli-usage.md

@@ -1,24 +1,24 @@
 +++
 title = "CLI usage"
-weight = 2
+weight = 20


Is that intended?

It was not intended for the "next" branch. I'm reorganizing the documentation in a "docs-next' branch on my fork. I changed the weights to multiples of 10 in case I need to add new sections (for example, I added an "Overview" section to "Getting Started"). Please revert.

Keats · 2019-11-26T19:30:23Z

Thanks, I'll push my changes directly after merging.

* Update installation.md * Update cli-usage.md * Update installation.md * Update directory-structure.md * Update configuration.md * Update overview.md * Update section.md * Update page.md * Update section.md * Update configuration.md * Update page.md * Update section.md * Update page.md * Update shortcodes.md * Update linking.md * Update table-of-contents.md * Update syntax-highlighting.md * Update taxonomies.md * Update search.md * Update sass.md * Update index.md * Update multilingual.md * Update overview.md * Update pages-sections.md * Update pagination.md * Update taxonomies.md * Update rss.md * Update sitemap.md * Update robots.md * Update 404.md * Update archive.md * Update overview.md * Update installing-and-using-themes.md * Update creating-a-theme.md * Update netlify.md * Update github-pages.md * Update gitlab-pages.md * Update index.md * Update page.md * Update section.md * Updates.

photong added 30 commits November 21, 2019 08:33

Update installation.md

b678c82

Update cli-usage.md

9603032

Update installation.md

86200f2

Update directory-structure.md

9750098

Update configuration.md

44ce379

Update overview.md

1251dee

Update section.md

751bea3

Update page.md

6327c75

Update section.md

3c379d3

Update configuration.md

d20eb8c

Update page.md

19c511c

Update section.md

9cef2ca

Update page.md

80fa637

Update shortcodes.md

b9ba051

Update linking.md

91a1f31

Update table-of-contents.md

e5087bd

Update syntax-highlighting.md

8af696d

Update taxonomies.md

e4bb3a8

Update search.md

785deb7

Update sass.md

d63008d

Update index.md

614099d

Update multilingual.md

f568f92

Update overview.md

02f6633

Update pages-sections.md

eaf7771

Update pagination.md

4a0e67a

Update taxonomies.md

b1739fb

Update rss.md

70a48e7

Update sitemap.md

30ea9e8

Update robots.md

d3ac9a2

Update 404.md

a1ec03d

photong added 7 commits November 22, 2019 15:59

Update archive.md

a7036c0

Update overview.md

623df7d

Update installing-and-using-themes.md

73146d0

Update creating-a-theme.md

6e3e8e3

Update netlify.md

60ab8f7

Update github-pages.md

dcd16e6

Update gitlab-pages.md

eca7a04

photong changed the title ~~Simple clean up of "Getting Started" and "Content" sections.~~ Simple clean up of documentation. Nov 22, 2019

photong and others added 5 commits November 22, 2019 20:19

Update index.md

066ec1b

Update page.md

7fd5b3e

Update section.md

4ae68d4

Updates.

d72bcb1

Merge branch 'next' of https://github.com/photong/zola into next

9769c68

Keats reviewed Nov 25, 2019

View reviewed changes

Keats merged commit 843c406 into getzola:next Nov 26, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Simple clean up of documentation. #849

Simple clean up of documentation. #849

photong commented Nov 22, 2019 •

edited

Loading

Keats left a comment

Keats Nov 25, 2019

photong Nov 25, 2019

Keats Nov 25, 2019

photong Nov 25, 2019 •

edited

Loading

Keats Nov 25, 2019

photong Nov 25, 2019

Keats Nov 25, 2019

photong Nov 25, 2019

Keats Nov 25, 2019

photong Nov 25, 2019

Keats Nov 25, 2019

photong Nov 25, 2019

Keats commented Nov 26, 2019


		```toml
		```TOML

Simple clean up of documentation. #849

Simple clean up of documentation. #849

Conversation

photong commented Nov 22, 2019 • edited Loading

Keats left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

photong Nov 25, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Keats commented Nov 26, 2019

photong commented Nov 22, 2019 •

edited

Loading

photong Nov 25, 2019 •

edited

Loading