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.

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

Docs/configuration update #1126

Merged
merged 3 commits into from
Aug 16, 2020
Merged

Conversation

uggla
Copy link
Contributor

@uggla uggla commented Aug 12, 2020

Sanity check:

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

Explanation:

  • Attempt to split the configuration file into sections to make it more readable and
    avoid configuration mistakes (Link checker sometimes flaky  #1056).
  • Move translation instructions to the right part.
  • Add a bit more explanations to the extra section.

@Keats
Copy link
Collaborator

Keats commented Aug 13, 2020

I'm not sure splitting the content is a good idea. We went from something people can copy/paste to something else where you might not know exactly where it goes.
cc @southerntofu

- Attempt to split the configuration file into sections to make it more readable and
  avoid configuration mistakes (getzola#1056).
- Move translation instructions to the right part.
- Add a bit more explanations to the extra section.
# [translations.en]
# title = "A title"
#
# translated title value will be available using {{ config.get_translation("fr", "title") }} in templates
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure about this.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Probably not needed, there should be a dedicated i18n page explaining how everything works.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Keats, ok I'm gonna remove it. I'll be happy to help about the i18n page, but right now I don't know how it works.

@uggla
Copy link
Contributor Author

uggla commented Aug 13, 2020

@Keats , I agree copy/paste is important. I have refined this PR according to your feedbacks. Let me know if it better suits what you expect ?

- A i18n page should be created to better explain it.
@Keats Keats merged commit 261a2ee into getzola:master Aug 16, 2020
@Keats
Copy link
Collaborator

Keats commented Aug 16, 2020

Thanks!

Keats added a commit that referenced this pull request Sep 1, 2020
* mention code block output change

* Update snap

* Update themes gallery (#1082)

Co-authored-by: GitHub Action <action@github.com>

* Deployment guide for Vercel

* Change wording a bit

* Update themes gallery (#1122)

Co-authored-by: GitHub Action <action@github.com>

* Add feed autodiscovery documentation (#1123)

* Add feed autodiscovery documentation

* Fix link in template

* Docs/configuration update (#1126)

* Update configuration documentation

- Attempt to split the configuration file into sections to make it more readable and
  avoid configuration mistakes (#1056).
- Move translation instructions to the right part.
- Add a bit more explanations to the extra section.

* Take into account @Keats feedbacks

* Remove short notice about translation usage

- A i18n page should be created to better explain it.

* add fix for (#1135) Taxonomies with identical slugs now get merged (#1136)

* add test and implementation for reverse pagination

* incorporate review changes

Co-authored-by: Michael Plotke <bdjnks@gmail.com>
Co-authored-by: Vincent Prouillet <balthek@gmail.com>
Co-authored-by: GitHub Action <action@github.com>
Co-authored-by: Samyak Bakliwal <w3bcode@gmail.com>
Co-authored-by: René Ribaud <uggla@free.fr>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants