chore: trigger docs deploy #1801

albttx · 2024-03-20T14:48:03Z

This trigger the github action netlify.yml on gnolang/docs.gno.land when a merge is done on master and the docs/ folder have updates.

I will need someone (cc: @moul ) to create and add a PAT to this repo secret 🙏🏼

EDIT:

This PR:

Bring a dev env for the docs.
Add github action to call gnolang/docs.gno.land netlify deploy action

I'm currently working on a netlify preview, but it's a bit more complexe than expected, it will come in another PR.

Contributors' checklist...

Added new tests, or not needed, or not feasible
Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
Updated the official documentation or not needed
No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
Added references to related issues and PRs
Provided any useful hints for running manual tests
Added new benchmarks to generated graphs, if any. More info here.

codecov · 2024-03-20T14:55:05Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 48.25%. Comparing base (a7881ca) to head (6f870b6).
Report is 20 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff            @@
##           master    #1801    +/-   ##
========================================
  Coverage   48.25%   48.25%            
========================================
  Files         408      409     +1     
  Lines       62338    62515   +177     
========================================
+ Hits        30081    30168    +87     
- Misses      29749    29824    +75     
- Partials     2508     2523    +15

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

thehowl · 2024-03-20T15:51:31Z

.github/workflows/deploy-docs.yml

rm netlify.toml on this repo? :)

+ rm -rf misc/docusaurus ;)

I don't think we should be removing misc/docusaurus, at least not until we have a preview deployment of ongoing docs/ or docusaurus 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.

@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

Here are two critical points regarding this PR:

Markdown content & docusaurus config are coupled. They both combine to make the docs the way they are.

People need to be able to preview the changes they are making to the docs in the docusaurus environment, not only in a simple markdown render.

I suggest we keep the working versions of both docs/ and misc/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.

Ok, I know how to handle that, I'll work on it!

@albttx
What's the status on this?

Still a work in progress, i made improvement today

leohhhn

@albttx Please reference the comment I left above before merging
https://github.com/gnolang/gno/pull/1801/files#r1532504955

zivkovicmilos · 2024-04-08T13:04:42Z

@albttx What is the status of this PR?

albttx · 2024-04-08T15:37:15Z

Hey @zivkovicmilos, if it's good for you, let's first merge this PR, as it is.
It will required to make a second PR on gnolang/docs.gno.land to update the sidebar.js file.

I'll work on a solution on a separate pull request.

albttx · 2024-04-24T13:22:17Z

link with : gnolang/docs.gno.land#21

leohhhn · 2024-04-25T17:45:20Z

Ok, so from what I understand:

This PR adds a docker image to the docs/ folder, that will pull the misc files from the docs.gno.land repo for a preview. This image can be used for a local preview and will be also used to run the CI preview on this repo.
This PR adds the actual dev image to be pulled by the monorepo, and adds a prod image for the actual deployment of the docs.

@albttx can you please confirm that this is the setup?

moul · 2024-04-26T08:10:10Z

docs/sidebars.js

no JS.

yaml, whatever, but no JS.

Just a reminder: The purpose of the docs folder is to be embedded in gnoweb. See #522 (comment).

I suggest using simple filenames with prefixes, such as 000_hello_world.md, 050_foo.md, etc.

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.

moul

see my last comments.

moul · 2024-04-26T08:14:02Z

docs/docker-compose.yml

Please delete this file from the repository. If necessary, relocate it to misc/, but I believe it's not essential.

This was asked to get a dev env when developing on the docs website to have a preview.

https://github.com/gnolang/gno/pull/1801/files#r1532504955

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/.

Related with #1801

albttx · 2024-04-26T09:43:06Z

Hello @moul , i just updated following your request.

i moved the docker-compose into misc/docs.gno.land
i replace the sidebars.js with a yaml file, see: chore: sidebars as yaml docs.gno.land#22

wdyt ?

moul · 2024-04-26T13:20:17Z

misc/docs.gno.land/docker-compose.yml

@@ -0,0 +1,27 @@
+version: "3"


Why can't you simply move this file to the other repository?

I'm fine not having it... But i don't know if it's will be really confortable to get easy preview of the docs when working on it...

@leohhhn what do you think ?

Read this: #1801 (comment)

If writing or previewing documents doesn't solely rely on having a basic editor and using the GitHub markdown preview, we must promptly remove the risky tool you've installed.

moul · 2024-04-26T13:24:45Z

docs/sidebars.yml

@@ -0,0 +1,146 @@
+---


It's not related to the docs. It's barely parseable by Gnoweb.

Please, consider my proposal to use numbered prefixes files and completely remove this file.

If you have valid reasons for not using my suggestion, please create a YAML file for documentation in the "docs/" directory. The file should contain only essential information relevant to docs/, editors, and gnoweb. Let's focus on what truly matters.

Everything related to docs.gno.land should be on the standalone website docs.gno.land, except for the .github/workflows trigger, in case a crontab is insufficient.

I understand your position, i first update following your comment asking no js, or for json or yaml ( cf: #1801 (comment) )

But i guess the easiest solutions is to keep a .js file inside the gnolang/docs.gno.land repository and make a PR on the docs.gno.land repository when it's required to update the sidebars.

The main issue is the existence of docs.gno.land. It's crucial to ensure that docs/ remains maintainable with an editor and GitHub. Imagine not having docs.gno.land. In such a case, managing page order should be done simply using markdown/filesystem in docs/. docs.gno.land should focus on theme, search engine, and deployment, without overshadowing the usefulness of the docs/ folder. Let's prioritize clarity in the docs/ folder.

Addresses #1801 (comment) Related with #1765 --------- Co-authored-by: Morgan <morgan@morganbaz.com>

albttx requested review from moul and a team as code owners March 20, 2024 14:49

github-actions bot assigned albttx Mar 20, 2024

thehowl reviewed Mar 20, 2024

View reviewed changes

thehowl mentioned this pull request Mar 20, 2024

chore: relocate supporting docs files #1587

Closed

9 tasks

leohhhn requested changes Mar 20, 2024

View reviewed changes

moul approved these changes Mar 21, 2024

View reviewed changes

zivkovicmilos added this to the 🏗4️⃣ test4.gno.land milestone Mar 25, 2024

leohhhn mentioned this pull request Apr 4, 2024

[docs] Docusaurus deployment preview #1888

Open

Kouteki mentioned this pull request Apr 18, 2024

Update the sidebars.js file #1951

Closed

albttx requested a review from a team as a code owner April 24, 2024 12:05

albttx added 7 commits April 24, 2024 14:13

chore: trigger docs deploy

ce8baa0

chore: rm -rf netlify.toml

f76d939

chore: rm -rf misc/docusaurus

5a68c2e

chore: add dev environment

f458df1

chore: set env variables for meilisearch

8891b94

chore: update docusaurus

e5d9af8

chore: update volumes

6d8f766

albttx force-pushed the ci/trigger-docs-deploy branch from 1c94e98 to 6d8f766 Compare April 24, 2024 13:21

chore: remove docusaurus build workflow

6cbd359

albttx requested review from thehowl, zivkovicmilos and leohhhn April 24, 2024 21:25

moul reviewed Apr 26, 2024

View reviewed changes

moul requested changes Apr 26, 2024

View reviewed changes

moul reviewed Apr 26, 2024

View reviewed changes

moul added a commit that referenced this pull request Apr 26, 2024

chore: update CODEOWNERS

4c11605

Related with #1801

moul mentioned this pull request Apr 26, 2024

chore: update CODEOWNERS #1986

Merged

albttx added 2 commits April 26, 2024 10:29

chore: sidebars as a yaml file

08fec75

chore: move docs.gno.land dev docker compose

7f35d1c

moul reviewed Apr 26, 2024

View reviewed changes

albttx added 2 commits April 29, 2024 15:49

chore: lint yml

4331c60

chore: remove docs.gno.land docker-compose

5b9d306

albttx mentioned this pull request Apr 29, 2024

chore: sidebars as yaml gnolang/docs.gno.land#22

Closed

chore: remove sidebars

6f870b6

moul approved these changes Apr 29, 2024

View reviewed changes

moul merged commit de2fc45 into master Apr 29, 2024
183 of 186 checks passed

moul deleted the ci/trigger-docs-deploy branch April 29, 2024 15:30

moul mentioned this pull request Apr 29, 2024

chore: reorganize docs folder with numbered prefixes #1999

Closed

10 tasks

thehowl added a commit that referenced this pull request May 2, 2024

chore: update CODEOWNERS (#1986)

3a4b742

Addresses #1801 (comment) Related with #1765 --------- Co-authored-by: Morgan <morgan@morganbaz.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: trigger docs deploy #1801

chore: trigger docs deploy #1801

albttx commented Mar 20, 2024 •

edited

Loading

codecov bot commented Mar 20, 2024 •

edited

Loading

thehowl Mar 20, 2024

albttx Mar 20, 2024 •

edited

Loading

leohhhn Mar 20, 2024 •

edited

Loading

albttx Mar 21, 2024

leohhhn Mar 21, 2024

albttx Mar 21, 2024

zivkovicmilos Mar 25, 2024

albttx Mar 28, 2024

leohhhn left a comment

zivkovicmilos commented Apr 8, 2024

albttx commented Apr 8, 2024

albttx commented Apr 24, 2024

leohhhn commented Apr 25, 2024

moul Apr 26, 2024

moul Apr 26, 2024 •

edited

Loading

albttx Apr 26, 2024

moul left a comment •

edited

Loading

moul Apr 26, 2024 •

edited

Loading

albttx Apr 26, 2024

moul Apr 26, 2024

albttx commented Apr 26, 2024

moul Apr 26, 2024

albttx Apr 26, 2024

moul Apr 27, 2024 •

edited

Loading

moul Apr 26, 2024

albttx Apr 29, 2024

moul Apr 29, 2024

chore: trigger docs deploy #1801

chore: trigger docs deploy #1801

Conversation

albttx commented Mar 20, 2024 • edited Loading

codecov bot commented Mar 20, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

albttx Mar 20, 2024 • edited Loading

Choose a reason for hiding this comment

leohhhn Mar 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leohhhn left a comment

Choose a reason for hiding this comment

zivkovicmilos commented Apr 8, 2024

albttx commented Apr 8, 2024

albttx commented Apr 24, 2024

leohhhn commented Apr 25, 2024

Choose a reason for hiding this comment

moul Apr 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

moul left a comment • edited Loading

Choose a reason for hiding this comment

moul Apr 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

albttx commented Apr 26, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

moul Apr 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

albttx commented Mar 20, 2024 •

edited

Loading

codecov bot commented Mar 20, 2024 •

edited

Loading

albttx Mar 20, 2024 •

edited

Loading

leohhhn Mar 20, 2024 •

edited

Loading

moul Apr 26, 2024 •

edited

Loading

moul left a comment •

edited

Loading

moul Apr 26, 2024 •

edited

Loading

moul Apr 27, 2024 •

edited

Loading