search

ava-labs / avalanche-docs

Protocol documentation for the Avalanche network.
https://docs.avax.network/
BSD 3-Clause "New" or "Revised" License
163 stars 374 forks source link

New Documentation Framework #1810

Closed ashucoder9 closed 2 months ago

ashucoder9 commented 2 months ago

Adds new framework for the documentation website.

vercel[bot] commented 2 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
avalanche-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 9, 2024 3:13pm
cloudflare-workers-and-pages[bot] commented 2 months ago

Deploying avalanche-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6fec935
Status:🚫  Build failed.

View logs

meaghanfitzgerald commented 2 months ago

There should also be a valid .github/workflows/ci.yml for CICD

meaghanfitzgerald commented 2 months ago

very in favor of abandoning vale but we should employ some sort of linter to check for grammar and spelling

meaghanfitzgerald commented 2 months ago

preview link for reference: https://avalanche-docs-git-new-release-ava-labs.vercel.app/

ashucoder9 commented 2 months ago

There should also be a valid .github/workflows/ci.yml for CICD

I believe we won't need these files. Vercel integration will take care of the CI/CD.

meaghanfitzgerald commented 2 months ago

There should also be a valid .github/workflows/ci.yml for CICD

I believe we won't need these files. Vercel integration will take care of the CI/CD.

if the CI fails will users be able to view logs with descriptive errors so they can correct them?

ashucoder9 commented 2 months ago

There should also be a valid .github/workflows/ci.yml for CICD

I believe we won't need these files. Vercel integration will take care of the CI/CD.

if the CI fails will users be able to view logs with descriptive errors so they can correct them?

contributors outside the Vercel app prolly won't be able to see the logs by default (except that their build failed), they can also run it on local to check.

there is a setting which allows us to open logs to public but comes with some security concerns, so a bit cautious before disabling it: https://vercel.com/docs/projects/overview#build-logs-and-source-protection

meaghanfitzgerald commented 2 months ago

There should also be a valid .github/workflows/ci.yml for CICD

I believe we won't need these files. Vercel integration will take care of the CI/CD.

if the CI fails will users be able to view logs with descriptive errors so they can correct them?

contributors outside the Vercel app prolly won't be able to see the logs by default (except that their build failed), they can also run it on local to check.

there is a setting which allows us to open logs to public but comes with some security concerns, so a bit cautious before disabling it: https://vercel.com/docs/projects/overview#build-logs-and-source-protection

definitely dont want the vercel logs to be public, but a simple workflow that runs yarn build and prints the output should suffice for in repo CI/CD

shyos commented 2 months ago

fyi; with this update, terraform scripts got removed from the repo and GCP tutorial links direct to 404 page.

https://docs.avax.network/nodes/on-third-party-services/google-cloud

Last version of terraform scripts, if anyone is searching it as well: https://github.com/ava-labs/avalanche-docs/tree/7e8127d4f7101504564669bdc3c0b6dea1d55364/static/scripts