Skip to content

Commit

Permalink
Merge #553
Browse files Browse the repository at this point in the history
553: Migrate docs hosting to Meilisearch subdomain r=brunoocasali a=Strift

# Pull Request

This PR aims at migrating the generated phpDocumentor docs to `php-sdk-docs.meilisearch.com` instead of Github Pages.

(Please ignore the Vercel preview below. It's not relevant anymore.)

## What does this PR do?

This PR:
- Adds the Fathom Analytics script to the generated HTML
- Update the title of the generated docs

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


Co-authored-by: Strift <laurent@meilisearch.com>
  • Loading branch information
meili-bors[bot] and Strift authored Jul 20, 2023
2 parents 2516568 + 23cd7fd commit 616916e
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 2 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ concurrency:
jobs:
build:
runs-on: ubuntu-latest
env:
DOCUMENTATION_TITLE: "Meilisearch PHP | Documentation"
steps:
- name: Checkout
uses: actions/checkout@v3
Expand All @@ -30,7 +32,7 @@ jobs:
restore-keys: |
${{ runner.os }}-phpdocumentor-
- name: Build with phpDocumentor
run: docker run --rm --volume "$(pwd):/data" phpdoc/phpdoc:3 -i tests/ -vv --target docs --cache-folder .phpdoc/cache --template default
run: docker run --rm --volume "$(pwd):/data" phpdoc/phpdoc:3 -i tests/ -vv --target docs --cache-folder .phpdoc/cache --template default --title "$DOCUMENTATION_TITLE"
- name: Upload artifact to GitHub Pages
uses: actions/upload-pages-artifact@v1
with:
Expand Down
11 changes: 11 additions & 0 deletions .phpdoc/template/base.html.twig
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{#
Extending the default phpDocumentor layout
https://github.com/phpDocumentor/phpDocumentor/blob/master/data/templates/default/layout.html.twig
#}

{% extends 'layout.html.twig' %}

{% block javascripts %}
{{ parent() }}
<script src="https://cdn.usefathom.com/script.js" data-site="QNBPJXIV" defer></script>
{% endblock %}
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
php-sdk-docs.meilisearch.com
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
## 📖 Documentation


To learn more about Meilisearch PHP, refer to the in-depth [Meilisearch PHP Documentation](https://meilisearch.github.io/meilisearch-php/). To learn more about Meilisearch in general, refer to our [documentation](https://www.meilisearch.com/docs/learn/getting_started/quick_start) or our [API reference](https://www.meilisearch.com/docs/reference/api/overview).
To learn more about Meilisearch PHP, refer to the in-depth [Meilisearch PHP Documentation](https://php-sdk-docs.meilisearch.com). To learn more about Meilisearch in general, refer to our [documentation](https://www.meilisearch.com/docs/learn/getting_started/quick_start) or our [API reference](https://www.meilisearch.com/docs/reference/api/overview).

## ⚡ Supercharge your Meilisearch experience

Expand Down

0 comments on commit 616916e

Please sign in to comment.