Skip to content
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

feat: add docs stie for api-testing #469

Merged
merged 4 commits into from
Jun 12, 2024

Conversation

yuluo-yx
Copy link
Collaborator

@yuluo-yx yuluo-yx commented Jun 1, 2024

  • Add docs site.

run make docs-serve in locally. then you can see:

image

@LinuxSuRen LinuxSuRen added the documentation Improvements or additions to documentation label Jun 1, 2024
.dockerignore Outdated Show resolved Hide resolved
Copy link
Owner

@LinuxSuRen LinuxSuRen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ERROR render of "section" failed: "/home/gitpod/.cache/hugo_cache/modules/filecache/modules/pkg/mod/github.com/google/[email protected]/layouts/docs/baseof.html:4:7": execute of template failed: template: docs/list.html:4:7: executing "docs/list.html" at <partial "head.html" .>: error calling partial: execute of template failed: html/template:partials/head.html:52:16: no such template "_internal/google_analytics_async.html"
ERROR render of "page" failed: "/home/gitpod/.cache/hugo_cache/modules/filecache/modules/pkg/mod/github.com/google/[email protected]/layouts/docs/baseof.html:4:7": execute of template failed: template: docs/single.html:4:7: executing "docs/single.html" at <partial "head.html" .>: error calling partial: execute of template failed: html/template:partials/head.html:52:16: no such template "_internal/google_analytics_async.html"
Built in 106 ms
Error: error building site: render: failed to render pages: render of "home" failed: "/home/gitpod/.cache/hugo_cache/modules/filecache/modules/pkg/mod/github.com/google/[email protected]/layouts/_default/baseof.html:4:7": execute of template failed: template: home.html:4:7: executing "home.html" at <partial "head.html" .>: error calling partial: execute of template failed: html/template:partials/head.html:52:16: no such template "_internal/google_analytics_async.html"
make[1]: *** [tools/make/docs.mk:26: docs-serve] Error 1
make[1]: Leaving directory '/workspace/api-testing'
make: *** [Makefile:19: _run] Error 2
gitpod /workspace/api-testing (0601-yuluo/add-docs-site) $ hugo version
hugo v0.126.2-8f3d902ce51512931f5759e9279d93e346c9e649 linux/amd64 BuildDate=2024-05-30T15:19:22Z VendorInfo=gohugoio

Copy link
Owner

@LinuxSuRen LinuxSuRen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer to merge the site into docs. And please let it CI workflow to make sure the site can build successfully.

site/Dockerfile Outdated Show resolved Hide resolved
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to avoid maintaining these files in two places? We already have this file in the root directory.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't seem like it would work, what's in the project is mandatory, what's in the docs is as well, and you can't bring in the md file from the project root from the docs site

Signed-off-by: yuluo-yx <[email protected]>
@yuluo-yx
Copy link
Collaborator Author

yuluo-yx commented Jun 2, 2024

ERROR render of "section" failed: "/home/gitpod/.cache/hugo_cache/modules/filecache/modules/pkg/mod/github.com/google/[email protected]/layouts/docs/baseof.html:4:7": execute of template failed: template: docs/list.html:4:7: executing "docs/list.html" at <partial "head.html" .>: error calling partial: execute of template failed: html/template:partials/head.html:52:16: no such template "_internal/google_analytics_async.html"
ERROR render of "page" failed: "/home/gitpod/.cache/hugo_cache/modules/filecache/modules/pkg/mod/github.com/google/[email protected]/layouts/docs/baseof.html:4:7": execute of template failed: template: docs/single.html:4:7: executing "docs/single.html" at <partial "head.html" .>: error calling partial: execute of template failed: html/template:partials/head.html:52:16: no such template "_internal/google_analytics_async.html"
Built in 106 ms
Error: error building site: render: failed to render pages: render of "home" failed: "/home/gitpod/.cache/hugo_cache/modules/filecache/modules/pkg/mod/github.com/google/[email protected]/layouts/_default/baseof.html:4:7": execute of template failed: template: home.html:4:7: executing "home.html" at <partial "head.html" .>: error calling partial: execute of template failed: html/template:partials/head.html:52:16: no such template "_internal/google_analytics_async.html"
make[1]: *** [tools/make/docs.mk:26: docs-serve] Error 1
make[1]: Leaving directory '/workspace/api-testing'
make: *** [Makefile:19: _run] Error 2
gitpod /workspace/api-testing (0601-yuluo/add-docs-site) $ hugo version
hugo v0.126.2-8f3d902ce51512931f5759e9279d93e346c9e649 linux/amd64 BuildDate=2024-05-30T15:19:22Z VendorInfo=gohugoio

have more informations?

deployments: write
id-token: write # to verify the deployment originates from an appropriate source

# Deploy to the github-pages environment
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@LinuxSuRen pls review it

Signed-off-by: yuluo-yx <[email protected]>
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
3 Security Hotspots

See analysis details on SonarCloud

Copy link
Owner

@LinuxSuRen LinuxSuRen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@LinuxSuRen LinuxSuRen merged commit 4a7f92c into LinuxSuRen:master Jun 12, 2024
12 of 14 checks passed
LinuxSuRen pushed a commit that referenced this pull request Jun 17, 2024
* chore(deps): update gitea/gitea docker tag to v1.20.5

* Update app version [skip ci]

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: github-action update-app-version <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants