Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify public dir in directory structure doc page (#2238) #2240

Merged
merged 3 commits into from
Jul 6, 2023
Merged

Clarify public dir in directory structure doc page (#2238) #2240

merged 3 commits into from
Jul 6, 2023

Conversation

kotx
Copy link
Contributor

@kotx kotx commented Jul 4, 2023

Sanity check:

  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Resolves #2238

@kotx kotx mentioned this pull request Jul 4, 2023
Closed
@kotx kotx changed the title Clarify public dir (#2238) Clarify public dir in directory structure doc page (#2238) Jul 4, 2023
Keats
Keats requested changes Jul 5, 2023
View reviewed changes
docs/content/documentation/getting-started/directory-structure.md Outdated
@@ -49,3 +49,7 @@ and available variables.
## `themes`
Contains themes that can be used for your site. If you are not planning to use themes, leave this directory empty.
If you want to learn about themes, see the [themes documentation](@/documentation/themes/_index.md).

## `public`
Contains the built site from [`zola build`](@/documentation/getting-started/cli-usage.md#build).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

zola serve might create it as well. As mentioned in the issue, this folder can be specified in zola build/server.

I think I would just mention that by default a public folder might appear when running zola build/serve that contains some of the output

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be fine now? LMK if I should make any more adjustments

Keats
Keats reviewed Jul 5, 2023
View reviewed changes
docs/content/documentation/getting-started/directory-structure.md Outdated
@@ -49,3 +49,6 @@ and available variables.
## `themes`
Contains themes that can be used for your site. If you are not planning to use themes, leave this directory empty.
If you want to learn about themes, see the [themes documentation](@/documentation/themes/_index.md).

## `public`
Contains the built site. Might appear from [`zola build`](@/documentation/getting-started/cli-usage.md#build) and [`zola serve`](@/documentation/getting-started/cli-usage.md#serve) depending on your configuration.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you move that text around L20 and remove the header? Also

Contains the built site

is technically incorrect for zola serve so I would remove it.

Something like:

You might also see a public directory if you are running the default zola build/serve commands which contains some output for the site: the full site for zola build and only the static assets for zola serve. This folder will be deleted/created automatically by zola serve.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed!

@Keats Keats merged commit a6bf876 into getzola:master Jul 6, 2023
biodranik pushed a commit to biodranik/zola that referenced this pull request Sep 12, 2023
@kotx @biodranik
Clarify public dir in directory structure doc page (getzola#2238) (g…
b93babe 
…etzola#2240)

* Clarify `public` dir (getzola#2238)

* Add `zola serve` to `public` dir description

* Move and rewrite `public` clarification
technimad pushed a commit to technimad/zola that referenced this pull request Sep 30, 2023
@kotx
Clarify public dir in directory structure doc page (getzola#2238) (g…
b1f8bd0 
…etzola#2240)

* Clarify `public` dir (getzola#2238)

* Add `zola serve` to `public` dir description

* Move and rewrite `public` clarification
Drodt pushed a commit to DerDrodt/zola that referenced this pull request Oct 10, 2023
@kotx @Drodt
Clarify public dir in directory structure doc page (getzola#2238) (g…
3417b9d 
…etzola#2240)

* Clarify `public` dir (getzola#2238)

* Add `zola serve` to `public` dir description

* Move and rewrite `public` clarification
fredr pushed a commit to fredr/zola that referenced this pull request Oct 21, 2023
@kotx @fredr
Clarify public dir in directory structure doc page (getzola#2238) (g…
f36adf1 
…etzola#2240)

* Clarify `public` dir (getzola#2238)

* Add `zola serve` to `public` dir description

* Move and rewrite `public` clarification
selfisekai pushed a commit to selfisekai/zola that referenced this pull request Nov 3, 2023
@kotx @selfisekai
Clarify public dir in directory structure doc page (getzola#2238) (g…
b7dfed4 
…etzola#2240)

* Clarify `public` dir (getzola#2238)

* Add `zola serve` to `public` dir description

* Move and rewrite `public` clarification
Newbytee pushed a commit to Newbytee/zola that referenced this pull request Dec 19, 2023
@kotx @Newbytee
Clarify public dir in directory structure doc page (getzola#2238) (g…
a64d924 
…etzola#2240)

* Clarify `public` dir (getzola#2238)

* Add `zola serve` to `public` dir description

* Move and rewrite `public` clarification
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Keats Keats Keats approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

public dir missing from directory structure page
2 participants
@kotx @Keats