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: reconfigure search on docs site for contributing, plugins, and starters #12503

Closed
marcysutton opened this issue Mar 11, 2019 · 9 comments
Closed
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@marcysutton
Copy link
Contributor

marcysutton commented Mar 11, 2019

Summary

Some commonly-searched terms come up empty even when there is content for them in a plugin. For example, when searching Google for "Gatsby createFilePath" or "Gatsby robots.txt", one can find plugins for those things (gatsby-source-filesystem and gatsby-plugin-robots-txt, respectively), but not when searching on Gatsbyjs.org itself.

It might be helpful to index packages so that Gatsby search results will include things like createFilePath and robots.txt. This has been asked before: #4028

From talking to the core team, it looks like packages were excluded on purpose; it would be good to understand the reasoning for this, as we determine the best way forward. An alternative would be to add more docs for things like createFilePath, but the question then would become "where should plugin-related docs live?"

@gatsbot gatsbot bot added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Mar 11, 2019
@pieh pieh added the no triage label Mar 11, 2019
@KyleAMathews
Copy link
Contributor

Were they always excluded? I remember being able to search for packages in the past.

@marcysutton
Copy link
Contributor Author

Looks like it was removed in September 2018, but I'm not sure why: algolia/docsearch-configs@01178d4

@marcysutton
Copy link
Contributor Author

Something else I just noticed: the new Contributing section isn't indexed either. Do we need to add something to the Algolia search config @DSchau ?

@gatsbot
Copy link

gatsbot bot commented Apr 19, 2019

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.

If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!

Thanks for being a part of the Gatsby community! 💪💜

@gatsbot gatsbot bot added the stale? Issue that may be closed soon due to the original author not responding any more. label Apr 19, 2019
@gatsbot
Copy link

gatsbot bot commented Apr 30, 2019

Hey again!

It’s been 30 days since anything happened on this issue, so our friendly neighborhood robot (that’s me!) is going to close it.

Please keep in mind that I’m only a robot, so if I’ve closed this issue in error, I’m HUMAN_EMOTION_SORRY. Please feel free to reopen this issue or create a new one if you need anything else.

Thanks again for being part of the Gatsby community!

@gatsbot gatsbot bot closed this as completed Apr 30, 2019
@marcysutton marcysutton reopened this May 10, 2019
@marcysutton marcysutton changed the title Docs: determine whether plugins can be indexed in search Docs: reconfigure search on docs site for contributing and plugins May 10, 2019
@jlengstorf jlengstorf added not stale and removed stale? Issue that may be closed soon due to the original author not responding any more. labels May 13, 2019
@jlengstorf jlengstorf self-assigned this May 13, 2019
@jlengstorf
Copy link
Contributor

I have a call with Algolia later this week — I will figure out how to actually make this fix possible.

@jackbravo
Copy link
Contributor

@jlengstorf how did the call with algolia go?

@jlengstorf
Copy link
Contributor

@jackbravo that discussion never ended up happening. I'm not sure where this stands; I'll defer to the Gatsby team on what next steps are.

@marcysutton marcysutton changed the title Docs: reconfigure search on docs site for contributing and plugins Docs: reconfigure search on docs site for contributing, plugins, and starters Apr 20, 2020
@LekoArts
Copy link
Contributor

LekoArts commented Nov 9, 2020

Since www isn't public anymore I've noted this internally as a ticket.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

No branches or pull requests

7 participants