getmeli / meli-docs Goto Github PK

We've already reached Algolia's free tier limits. We need to replace it with something else. Gatsby has a few plugins for this I believe.

On the homepage, api points to /api/api which gives a 404.

However, this is valid:

https://docs.meli.sh/api/get-started

Alternatively, the site needs up to be updated to handle /api as a page when clicking on API in the sidebar (currently does nothing), to be consistent with going to /integrations when clicking on INTEGRATIONS.

I have PRs which are failing on this GH Actions publish step:

https://github.com/getmeli/meli-docs/blob/latest/.github/workflows/main.yml#L25

This is expected, as my fork does have secrets setup to publish to someone else's NPM or GH account.

Another problem is that even if the maintainer of the repo (who does have access) makes a PR from a branch to latest, the publish step will run on the branch (which may not be production ready). It would be safer to make the publish step on run when code is on latest branch (or if you were more conservative, only run when a tag is created).

Therefore can I suggest that an if conditional which makes the publish step only run when the branch is latest? I've used this in my Vue project to skip publishing when the event type is pull_request (which avoids hardcoding latest or master).

https://github.com/MichaelCurrin/badge-generator/blob/master/.github/workflows/main.yml#L51-L52

This button currently works but is not smooth.

Steps to reproduce bug

1. Go to homepage (or any page) https://docs.meli.sh/
2. Click on Edit on Github button. It's link is https://github.com/getmeli/meli-docs/tree/master/src/data/docs/index.md
3. When you click through, you'll be warned that the branch master does not exist and that it will use latest instead.

Solution

Change the button to use latest instead of master in the URL.

Therefore a change to .env.example is necessary.

Outside of the codebase, if there are any environment variables set on the GH repo secrets or remote server, then the env variable needs to be updated there to be the maintainer.

When you run npm run build, the docs loads properly. When you change a page, Gatsby rebuilds the docs indefinitely.

pls add https://docs.meli.sh to the repo info
thx