Skip to content

Create cronjob workflow to index website docs in Algolia #417

@SenseException

Description

@SenseException

There is currently no automated build step to index the docs in Algolia for the website search bar. This has the following reasons:

  • There is an easy to reach limit per month for Algolia where the search won't work anymore if this limit is exceeded.
  • There is no reason to build every project's documentation all the time since some don't change very often.

To be able to update the docs regularly and keep the search and its results up-to-date a workflow should be created that builds the indexes at a time before the monthly Algolia limit gets a reset. This way it should be possible to prioritize the users of the search and keep the search availability. Because projects like ORM and DBAL are more frequented than e.g. Annotations, we can also plan different runs for every project in Doctrine to spare Algolia requests.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions