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: add section about disabling indexing #545

Conversation

florian-lefebvre
Copy link
Contributor

Following #486

cc @simonswiss

@changeset-bot
Copy link

changeset-bot bot commented Aug 17, 2023

⚠️ No Changeset found

Latest commit: 6fd7674

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Aug 17, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
keystar-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 23, 2023 11:38am
keystatic ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 23, 2023 11:38am
keystatic-site ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 23, 2023 11:38am

@simonswiss
Copy link
Collaborator

Hey @florian-lefebvre

I know I asked you to open this PR in the Astro guide, but I sort of changed my mind on where this information should belong.

Last week and the conversations with the Astro docs team led us to a huge re-think of how we should approach guides, particularly framework integration guides.

After a major rewrite of this guide with a sharp focus on avoiding any "side quests", I can't help but feel that this section about shutting down /keystatic routes in production should belong somewhere else. It just snaps the user out of the procedural, step by step installation.

I see this info in something like a recipe or a tutorial, for a specific need. It's great content and very useful when you need it, but IMO, it does not belong in the "get setup with Astro" guide itself.

I like what the Astro docs do with recipes:

CleanShot 2023-08-23 at 21 37 06@2x

If you don't mind, I'll try to stand a "Recipes" section in the nav tomorrow and make your contribution one of these guides.

I think it will work better that way.

Sorry about the flip-flopping around 😅 I've become very passionate about keeping integration guides as short and to-the-point as possible, and move all tangential content to another place.

Let me know what you think!

@simonswiss
Copy link
Collaborator

Update: I've tried two things: a blog post, and a new recipes section:

CleanShot 2023-08-23 at 22 13 30@2x CleanShot 2023-08-23 at 22 12 15@2x

The blog post is cool because it has your author link in it that you can point to your portfolio or other link, and it's nice to have community contributions in there. But if we go that route, we'll need to revisit the blog index copy that mentions news and updates from the Keystatic team.

I'll push this commit so you can have a look at both, and we can all decide what the best implementation is.

@florian-lefebvre
Copy link
Contributor Author

Hey! No worries, I also think it makes more sense to get it out of the integration guide. I think recipes are more relevant so that it's not mixed with "official" posts from the team.

Regarding the author link, one idea could be to add contributors to recipes like on nuxt v2 section (scroll all the way down on this page).

Wdyt?

@simonswiss
Copy link
Collaborator

Gotta go to bed now, but I've pushed my code in this branch (did not have access to push in your fork): #579

That PR contains all the commit history of this PR here.

I also think the recipes is a better place. Right now all docs pages are the same content type in Keystatic, so adding an author would mean every docs page has an author field.

I think we can add a contributed by aside callout at the top of the recipe for that effect 👍

Feel free to make suggestions, and let's try to get this merged tomorrow!

@simonswiss simonswiss closed this Sep 4, 2023
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.

4 participants