-
Notifications
You must be signed in to change notification settings - Fork 388
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: trigger docs deploy #1801
Changes from 7 commits
ce8baa0
f76d939
5a68c2e
f458df1
8891b94
e5d9af8
6d8f766
6cbd359
08fec75
7f35d1c
4331c60
5b9d306
6f870b6
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
name: deploy docs on gnolang/docs.gno.land repository | ||
on: | ||
push: | ||
branches: | ||
- master | ||
paths: | ||
- "docs/**" | ||
|
||
jobs: | ||
trigger-netlify-docs-deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/github-script@v6 | ||
with: | ||
github-token: ${{ secrets.DOCS_DEPLOY_PAT }} | ||
script: | | ||
await github.rest.actions.createworkflowDispatch({ | ||
owner: 'gnolang', | ||
repo: 'docs.gno.land', | ||
workflow_id: 'netlify.yml', | ||
ref: 'main' | ||
}) |
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please delete this file from the repository. If necessary, relocate it to misc/, but I believe it's not essential. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This was asked to get a dev env when developing on the docs website to have a preview. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. OK, but please, do it in the other repository. The other repository should focus on docs.gno.land for development and production. It should include a command to "fetch docs/" from the main repository for both development and production purposes. docs.gno.land is not a development tool linked to the monorepo. The docs/ folder should solely contain documentation, not web content, scripts, etc. The thing to do in the current repo is to update gnoweb to embed docs/. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
version: "3" | ||
|
||
services: | ||
docusaurus: | ||
image: ghcr.io/gnolang/docs.gno.land:dev | ||
volumes: | ||
- .:/app/docs | ||
- ./sidebars.js:/app/docusaurus/sidebar.js | ||
ports: | ||
- 3000:3000 | ||
environment: | ||
- MEILISEARCH_URL="localhost:7700" | ||
- MEILISEARCH_API_KEY="masterKey" | ||
- MEILISEARCH_INDEX_UID="dev" | ||
|
||
meilisearch: | ||
image: getmeili/meilisearch:latest | ||
restart: unless-stopped | ||
environment: | ||
- MEILI_MASTER_KEY=masterKey | ||
- MEILI_NO_ANALYTICS=true | ||
- MEILI_ENV=development | ||
- MEILI_LOG_LEVEL=info | ||
- MEILI_DB_PATH=/data.ms | ||
ports: | ||
- 7700:7700 | ||
#volumes: | ||
# - ./data.ms:/data.ms |
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. no JS. yaml, whatever, but no JS. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just a reminder: The purpose of the I suggest using simple filenames with prefixes, such as There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I put a yaml file. Maybe we can in another PR think to have a different solution using the markdown header to gathers the informations + prefixes as you mentionned. |
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
rm netlify.toml
on this repo? :)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+
rm -rf misc/docusaurus
;)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we should be removing
misc/docusaurus
, at least not until we have a preview deployment of ongoingdocs/
ordocusaurus
PRs. This is because this is currently the only way to preview how the change in the docs will look like while making it. Also, the sidebar ordering is done in the docusaurus folder.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@leohhhn production has already been migrated to the repository gnolang/docs.gno.land.
So any changes in misc/docusaurus won't have any preview anymore. The search engine isn't developed here either.
IF there is missing stuff in gnolang/docs.gno.land, we must migrate them right now.
Keeping misc/docusaurus will only lead to confusions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here are two critical points regarding this PR:
I suggest we keep the working versions of both
docs/
andmisc/docusaurus
in the monorepo, and on each merge to master a CI copies over both folders to the docs.gno.land repo, and deploys over there.If there is another way to fulfill both of the points above, please let me know.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, I know how to handle that, I'll work on it!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@albttx
What's the status on this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Still a work in progress, i made improvement today