Skip to content

Commit

Permalink
Add Search
Browse files Browse the repository at this point in the history
  • Loading branch information
DRSchlaubi committed Jun 30, 2024
1 parent f9a39f4 commit e140910
Show file tree
Hide file tree
Showing 5 changed files with 79 additions and 36 deletions.
101 changes: 69 additions & 32 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,53 +11,90 @@ permissions:

env:
PRODUCT: docs/kord
DOC_ARTIFACT: webHelpKORD2-all.zip
ALGOLIA_ARTIFACT: algolia-indexes-XX.zip

ARTIFACT: webHelpKORD2-all.zip
ALGOLIA_ARTIFACT: 'algolia-indexes-KORD.zip'
INSTANCE: 'docs/kord'
DOCKER_VERSION: '241.16003'
ALGOLIA_APP_NAME: 'JYGRRNLGJT'
ALGOLIA_INDEX_NAME: 'kord_wiki'
ALGOLIA_KEY: '${{ secrets.ALGOLIA_KEY }}'
CONFIG_JSON_PRODUCT: 'kord'
CONFIG_JSON_VERSION: '1.0'
jobs:
build-job:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Build Writerside docs using Docker
uses: JetBrains/writerside-github-action@v3
- name: Upload documentation
uses: actions/upload-artifact@v3
with:
name: help
path: artifacts/${{ env.DOC_ARTIFACT }}
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Build docs using Writerside Docker builder
uses: JetBrains/writerside-github-action@v4
with:
instance: ${{ env.INSTANCE }}
artifact: ${{ env.ARTIFACT }}
- name: Save artifact with build results
uses: actions/upload-artifact@v4
with:
name: docs
path: |
artifacts/${{ env.ARTIFACT }}
artifacts/report.json
artifacts/${{ env.ALGOLIA_ARTIFACT }}
retention-days: 7
# # Add the step below to upload Algolia indexes
# - name: Upload algolia-indexes
# uses: actions/upload-artifact@v3
# with:
# name: algolia-indexes
# path: artifacts/${{ env.ALGOLIA_ARTIFACT }}
# retention-days: 7

test:
needs: build
runs-on: ubuntu-latest
steps:
- name: Download artifacts
uses: actions/download-artifact@v4
with:
name: docs
path: artifacts
- name: Test documentation
uses: JetBrains/writerside-checker-action@v1
with:
instance: ${{ env.INSTANCE }}
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
# Requires the build-job results
needs: build-job
needs: [build, test]
runs-on: ubuntu-latest
steps:
- name: Download artifact
uses: actions/download-artifact@v3
- name: Download artifacts
uses: actions/download-artifact@v4
with:
name: help
name: docs
- name: Unzip artifact
uses: montudor/action-zip@v1
with:
args: unzip -qq ${{ env.DOC_ARTIFACT }} -d dir
run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d dir
- name: Setup Pages
uses: actions/configure-pages@v2
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
uses: actions/configure-pages@v4
- name: Package and upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: dir
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
uses: actions/deploy-pages@v4
publish-indexes:
needs: [build, test, deploy]
runs-on: ubuntu-latest
container:
image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-3
steps:
- name: Download artifact
uses: actions/download-artifact@v4
with:
name: docs
- name: Unzip artifact
run: |
unzip -O UTF-8 -qq '${{ env.ALGOLIA_ARTIFACT }}' -d algolia-indexes
env algolia-key='${{env.ALGOLIA_KEY}}' java -jar /opt/builder/help-publication-agent.jar \
update-index \
--application-name '${{env.ALGOLIA_APP_NAME}}' \
--index-name '${{env.ALGOLIA_INDEX_NAME}}' \
--product '${{env.CONFIG_JSON_PRODUCT}}' \
--version '${{env.CONFIG_JSON_VERSION}}' \
--index-directory algolia-indexes/ \
2>&1 | tee algolia-update-index-log.txt
3 changes: 0 additions & 3 deletions .idea/misc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/vcs.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions docs/buildprofiles.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
<variables>
<enable-browser-edits>true</enable-browser-edits>
<browser-edits-url>https://github.com/kordlib/kord-wiki/edit/main/docs/</browser-edits-url>
<algolia-id>JYGRRNLGJT</algolia-id>
<algolia-index>kord_wiki</algolia-index>
<algolia-api-key>5923511b60eb8db61a58902f9d3d4cc4</algolia-api-key>
</variables>
<build-profile instance="kord"/>
<footer>
Expand Down
2 changes: 1 addition & 1 deletion docs/v.list
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
<!DOCTYPE vars SYSTEM "https://helpserver.labs.jb.gg/help/schemas/mvp/vars.dtd">
<vars>
<var name="product" value="Kord"/>
<var name="version" value="0.8.2"/>
<var name="version" value="0.14.0"/>
</vars>

0 comments on commit e140910

Please sign in to comment.