[📝 Docs]: Improvement in installation instructions
What Docs changes are you proposing?
I would like to contribute to INSTALLATION.md by improving the installation instructions.
The installation guide is great but it could be better.
Some things that I think can be clarified or added are :
- Adding step mentioning to fork the repo.
- Add the
git clonecommand/instruction before thegit submodule init - Give the link to Algolia to sign up and get credentials for the
env. - Since the Algolia dashboard has two types of API keys which are
Admin API KeyandSearch API Keywe can mention that the contributor needs to get theSearch API Key.
I want to understand if these changes are worth making. If they are, I would like to work on this.
Code of Conduct
- [X] I agree to follow this project's Code of Conduct
Forking the repo isn't necessary to install (although I suppose most people installing are likely to be contributing, which does need a fork).
i want to work on this issue ,kindly assign me this issue @benjagm ,if this issue is opened and no one is assigned
Algolia? Is this something new or are we already using this?
If it's something new, I'd like to understand why we need it.
@gregsdennis If I remember correctly it is being used for the search functionality.
Hi everyone. I'd like to clarify that we are using DocSearch that this an opensource solution from Algolia and not Algolia. The second point is this step is not necessary to run this in local environment, this is why we are merged this PR https://github.com/json-schema-org/website/pull/1090 to make it clear. For this reason I think is better to close this issue.
Closed this issue per @benjagm 's suggestion.