search

ethereum / ethereum-org-website

Ethereum.org is a primary online resource for the Ethereum community.
https://ethereum.org/
MIT License
5.05k stars 4.79k forks source link

Update Comments in `.env.example` #11937

Open TylerAPfledderer opened 11 months ago

TylerAPfledderer commented 11 months ago

Add comments for the set of env variables for the Algolia search in .env.example. Either clearly define a set of keys available to use for the project when testing the functionality with content in the project or supply the test keys provided by the DocSearch docs.

Secondly, update comment to state that .env.example file name needs to be converted to .env.local when in use, per NextJS requirement.

github-actions[bot] commented 10 months ago

This issue is stale because it has been open 45 days with no activity.

wackerow commented 4 months ago

Looks like this is still needed. I'm in favor of just using the test keys provided by DocSearch docs as a fallback.. any foreseeable issues with using this just for testing?

@TylerAPfledderer Happy to assign but also don't want to assume. Pretty well defined task, opening for community in the meantime.

TylerAPfledderer commented 4 months ago

@wackerow last time I tested this, I saw no issues.

We can leave this open to the community for now.

corwintines commented 3 months ago

Still open for someone to take :)

TylerAPfledderer commented 3 months ago

Point out here that my comment about using .env.local may not actually be necessary here. It is more dependent on project strategy in how we work with the variables depending on environment what .env file Netlify needs to build with.

So no need to change the filename here! :)

github-actions[bot] commented 2 months ago

This issue is stale because it has been open 30 days with no activity.