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

guides: Add instructions for multiple SSG tools #122

Merged
merged 12 commits into from
Jan 8, 2024
Merged

Conversation

davlgd
Copy link
Collaborator

@davlgd davlgd commented Dec 30, 2023

Checklist

  • My PR is related to an opened issue : #

⚠️ If changes affect GitHub Action files

  • I have added tests to cover my changes : link

Pull request type

Please check the type of change your PR introduces:

  • Documentation content changes
  • Bugfix on the site
  • Build related changes
  • Other (please describe):

Description

New guides for multiple SSG:

  • Astro
  • Docusaurus
  • 11ty
  • Hexo
  • Hugo
  • Lume/Deno
  • mdBook
  • MkDocs
  • Nuxt

I used partials for shared instructions and added SVG icons

Reviewes

Who should review these changes? @

@davlgd davlgd self-assigned this Dec 30, 2023
Copy link

Deployment has finished 👁️👄👁️ Your app is available here

@juliamrch
Copy link
Collaborator

juliamrch commented Jan 2, 2024

Build folder

Update: after running some tests, that seems to be an issue in our Node runtime, and not Static.

It should be noted that folders like /dist or /build in JavaScript/Typescript based frameworks aren't committed by default, and that Clever Cloud permission levels will log "permission denied" when trying to create it and use it as webroot.

In these tutorials, we need to specify that the user must:

1. Build locally the site before the first deploy
2. Commit the build folder

Files inside the /dist and /build can be omitted, because they will be recreated again while deploying.

For example, see these instructions on deploying a T3 app on Clever Cloud.

Copy link
Collaborator

@juliamrch juliamrch left a comment

Choose a reason for hiding this comment

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

I find all these new guides amazing. Thanks for all this work.

Only change to ensure presentation consistency and readability is to replace the title by the framework name, and we should be good to go.

content/guides/static/astro.md Outdated Show resolved Hide resolved
content/guides/static/docusaurus.md Outdated Show resolved Hide resolved
content/guides/static/eleventy.md Outdated Show resolved Hide resolved
content/guides/static/hexo.md Outdated Show resolved Hide resolved
content/guides/static/hugo.md Outdated Show resolved Hide resolved
content/guides/static/lume-deno.md Outdated Show resolved Hide resolved
content/guides/static/mdbook.md Outdated Show resolved Hide resolved
content/guides/static/mkdocs.md Outdated Show resolved Hide resolved
content/guides/static/nuxt.md Outdated Show resolved Hide resolved
@davlgd
Copy link
Collaborator Author

davlgd commented Jan 2, 2024

I'm not sure so short titles will be good for SEO. Can you check with marketing team?

@juliamrch
Copy link
Collaborator

I'm not sure so short titles will be good for SEO. Can you check with marketing team?

It's not a SEO but a readability issue. Readability and clarity in sidebar for the doc is always privileged, and yes, even over SEO. Check the rest of the titles in /guides: it's the framework name, and that's it. The SEO is handled by the description in metadata.

@davlgd
Copy link
Collaborator Author

davlgd commented Jan 2, 2024

The metadata is not enough for a good SEO strategy, that's my point. We also need these guides to be found/read. I agree on the importance of readability, but it can't be only one or the other. It's why I asked to involve marketing team to reach a consensus on this.

Copy link
Collaborator

@juliamrch juliamrch left a comment

Choose a reason for hiding this comment

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

Replace path to avoid hiding frameworks in another level and let them be indexed by alphabetical order as intended for this page.

content/guides/_index.md Show resolved Hide resolved
content/guides/static/_index.md Outdated Show resolved Hide resolved
static/partials/guides/cards-static.md Outdated Show resolved Hide resolved
@juliamrch
Copy link
Collaborator

The metadata is not enough for a good SEO strategy, that's my point. We also need these guides to be found/read. I agree on the importance of readability, but it can't be only one or the other. It's why I asked to involve marketing team to reach a consensus on this.

Head of Marketing has already approved the structure of this page when building the site and restructuring the doc. It took a lot of discussions and research. This subject has already been covered.

@davlgd
Copy link
Collaborator Author

davlgd commented Jan 3, 2024

If it's ok for marketing team, it's ok for me

Copy link

github-actions bot commented Jan 3, 2024

🚀 Your app has been updated and is available here

juliamrch
juliamrch previously approved these changes Jan 3, 2024
Copy link
Collaborator

@juliamrch juliamrch left a comment

Choose a reason for hiding this comment

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

Subjects left:

  • Do we need a partial for the cards, since we a a single level in /guides/_index/md?
  • Subtitle partial missing to keep the look consistent

I can do these changes after merging and before pushing to prod, it's not a big issue

static/partials/guides/cards-static.md Outdated Show resolved Hide resolved
static/partials/guides/cards-static.md Outdated Show resolved Hide resolved
content/guides/_index.md Outdated Show resolved Hide resolved
@juliamrch juliamrch added the documentation Improvements or additions to documentation label Jan 3, 2024
juliamrch
juliamrch previously approved these changes Jan 5, 2024
@juliamrch
Copy link
Collaborator

juliamrch commented Jan 5, 2024

There were some conflicts in icons.yml that I just fixed (by setting current fluent and grade icons). Could you review it @davlgd ? And if everything is ok we can merge the new guides.

@davlgd
Copy link
Collaborator Author

davlgd commented Jan 5, 2024

It's ok for me @juliamrch

@juliamrch juliamrch merged commit 21fdc84 into main Jan 8, 2024
2 of 3 checks passed
@juliamrch juliamrch deleted the davlgd-static-guides branch January 8, 2024 13:38
Copy link

github-actions bot commented Jan 8, 2024

Your review app has been deleted 👋

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants