22 Commits

Author SHA1 Message Date
Abin Simon
6846ebf964
Skip mdgen build in case of valid mdgen in Makefile (#1214)
## Description

`_validatemdgen` resulted in the build for mdgen to always happen. This fixes that.

## Type of change

<!--- Please check the type of change your PR introduces: --->
- [ ] 🌻 Feature
- [ ] 🐛 Bugfix
- [x] 🗺️ Documentation
- [ ] 🤖 Test
- [x] 💻 CI/Deployment
- [ ] 🐹 Trivial/Minor

## Issue(s)

<!-- Can reference multiple issues. Use one of the following "magic words" - "closes, fixes" to auto-close the Github issue. -->
* #<issue>

## Test Plan

<!-- How will this be tested prior to merging.-->
- [x] 💪 Manual
- [ ]  Unit test
- [ ] 💚 E2E
2022-10-20 00:19:41 +00:00
Abin Simon
17221f23d0
Drop option to build without Docker in Makefile (#1204)
## Description

Having both option could possibly lead to issues with caching.

## Type of change

<!--- Please check the type of change your PR introduces: --->
- [ ] 🌻 Feature
- [ ] 🐛 Bugfix
- [ ] 🗺️ Documentation
- [ ] 🤖 Test
- [x] 💻 CI/Deployment
- [ ] 🐹 Trivial/Minor

## Issue(s)

<!-- Can reference multiple issues. Use one of the following "magic words" - "closes, fixes" to auto-close the Github issue. -->
* #<issue>

## Test Plan

<!-- How will this be tested prior to merging.-->
- [x] 💪 Manual
- [ ]  Unit test
- [ ] 💚 E2E
2022-10-19 06:52:06 +00:00
Niraj Tolia
64c796ff18
Add git shortref to docs build (#1205)
## Description

Add git version to docs build

This will help us verify what version of docs has been published. This should be replaced by the git tag for production builds.

## Type of change

<!--- Please check the type of change your PR introduces: --->
- [x] 🌻 Feature

## Test Plan

<!-- How will this be tested prior to merging.-->
- [x] 💪 Manual
2022-10-19 06:15:55 +00:00
Niraj Tolia
7dd3b07db4
Corso docs container should be in the corso namespace (#1208)
## Description

Removes an alcion reference from the docs container

## Type of change

- [x] 🐛 Bugfix

## Test Plan

- [x] 💪 Manual
2022-10-19 06:00:43 +00:00
Abin Simon
4b94c4f012
Option to not use docker for Makefile in docs/website (#1087)
## Description

This makes it so that we have an option to locally run all Makefile targets without having to go through Docker. That said, it retains Docker as the default way to run it, but now we can set an evn variable `CORSO_USE_DOCKER=-1` to skip running through docker. I understand if this looks a bit hacky and don't want to add it in, but thought I wold propose this anyways. While not major, I was able to get a good amount of decrease in build times.

## Type of change

<!--- Please check the type of change your PR introduces: --->
- [ ] 🌻 Feature
- [ ] 🐛 Bugfix
- [ ] 🗺️ Documentation
- [ ] 🤖 Test
- [x] 💻 CI/Deployment
- [ ] 🐹 Trivial/Minor

## Issue(s)

<!-- Can reference multiple issues. Use one of the following "magic words" - "closes, fixes" to auto-close the Github issue. -->
* #<issue>

## Test Plan

<!-- How will this be tested prior to merging.-->
- [x] 💪 Manual
- [ ]  Unit test
- [ ] 💚 E2E
2022-10-14 03:18:50 +00:00
Keepers
5f0f013458
fix docs buildimage bug due to inline comments (#1154) 2022-10-12 11:10:58 -06:00
Niraj Tolia
b7db1e0912
Fix disappearing sidebar for CLI landing page (#994)
## Description

Fix disappearing sidebar for CLI landing page

## Type of change

- [x] 🐛 Bugfix
- [x] 🗺️ Documentation

## Test Plan

- [x] 💪 Manual
2022-09-30 04:53:14 +00:00
Georgi Matev
11a7490400
Fixing docs build break (#992)
## Description

Apparently `go mod tidy` was not the right way to go to ensure dependencies were there when building `mdgen`

## Type of change

<!--- Please check the type of change your PR introduces: --->
- [ ] 🌻 Feature
- [x] 🐛 Bugfix
- [ ] 🗺️ Documentation
- [ ] 🤖 Test
- [ ] 💻 CI/Deployment
- [ ] 🐹 Trivial/Minor

## Issue(s)

<!-- Can reference multiple issues. Use one of the following "magic words" - "closes, fixes" to auto-close the Github issue. -->

## Test Plan

<!-- How will this be tested prior to merging.-->
- [x] 💪 Manual
- [ ]  Unit test
- [ ] 💚 E2E
2022-09-29 22:24:12 +00:00
Georgi Matev
db7128d627
Fix docs dev build when dependencies are not installed (#915)
Make sure dependencies are properly installed before building

<!-- Insert PR description-->

## Type of change

<!--- Please check the type of change your PR introduces: --->
- [ ] 🌻 Feature
- [x] 🐛 Bugfix
- [ ] 🗺️ Documentation
- [ ] 🤖 Test
- [ ] 💻 CI/Deployment
- [ ] 🐹 Trivial/Minor

## Issue(s)

## Test Plan

<!-- How will this be tested prior to merging.-->
- [x] 💪 Manual
- [ ]  Unit test
- [ ] 💚 E2E
2022-09-20 19:06:38 +00:00
Georgi Matev
f72b1e9935
Makefile should pick up any changes in /src subfolder not just first level (#777)
## Description

Globs not picking up changes to anything beyond first level of source files and not rebuilding on changes to mdgen.go for example. Switch to `find` which should also be more portable.


## Type of change

Please check the type of change your PR introduces:
- [ ] 🌻 Feature
- [x] 🐛 Bugfix
- [ ] 🗺️ Documentation
- [ ] 🤖 Test
- [ ] 🐹 Trivial/Minor

## Issue(s)


## Test Plan

<!-- How will this be tested prior to merging.-->

- [x] 💪 Manual
- [ ]  Unit test
- [ ] 💚 E2E
2022-09-06 17:59:43 +00:00
Georgi Matev
137123294a
Auto-generate CLI docs in docs dev tooling (#721)
## Description

Auto-generate CLI docs in docs dev tooling. 
* Add new Makefile target to rebuild the `mdgen` binary, only if needed. This helps with slow in container builds. Relies on host caching of both modules and the actual binary. This approach is probably not suitable for the actual docs CI build. 
* Actual generation is fast and done every time when using relevant docs dev tooling commands. 

NOTE: .gitignore may need to be adjusted if we switch to creating the CLI docs as part of build and tooling as opposed to the current automated PR with changes. 

## Type of change

Please check the type of change your PR introduces:
- [x] 🌻 Feature
- [ ] 🐛 Bugfix
- [x] 🗺️ Documentation
- [ ] 🤖 Test
- [ ] 🐹 Trivial/Minor

## Issue(s)

## Test Plan

<!-- How will this be tested prior to merging.-->

- [x] 💪 Manual
- [ ]  Unit test
- [ ] 💚 E2E
2022-09-01 18:50:09 +00:00
Georgi Matev
802001513f
Some quality of life docs tooling improvements (#664) 2022-08-26 19:03:36 -07:00
Niraj Tolia
5739f903ff
Docs changes for GitHub Actions (#69) (#70) 2022-05-24 12:38:48 -07:00
Niraj Tolia
2564b32841
Add Mermaid support to the Corso documentation platform (#64)
* Add MDX and Mermaid
* Configure Docusaurus for Mermaid
2022-05-20 13:13:21 -07:00
Niraj Tolia
85a06d2409
Corso documentation platform changes (#62)
* Add tools requirements for Corso docs

* Add README.md to Vale checks and ensure a clean run

* Swap from Discord to GH discussions
2022-05-20 11:00:44 -07:00
Niraj Tolia
cab6a515d9
Separate internal and user-facing docs (#60)
* Move CLI proposal to internal docs/design location
* Add previously-used headers to CLI design doc
2022-05-20 10:44:39 -07:00
Niraj Tolia
71f04fa8d0
Tweak config settings and apply Corso docs fixes (#59)
- Disable the readability style checker for now
- Remove all errors and warnings with the fixed Vale globbing
- Rename template directory
2022-05-20 10:28:40 -07:00
Niraj Tolia
930d9bd132
Internal docs (#58)
* Move CLI abstract
* Add docs index for Corso dev resources
* Tweak CLI proposal title
2022-05-19 16:27:01 -07:00
Niraj Tolia
c3c3613a71
Docs: Allow for a clean run of make check (#57) 2022-05-19 14:32:30 -07:00
Niraj Tolia
b903d962d3
Add Markdown linting (#52)
- Also renames `make vale` to `make check`
- Addresses a part of #15
2022-05-19 10:45:31 -07:00
Niraj Tolia
038d94b818
Add Vale linting to docs (#47)
* Add vale to docs build image

* Add Vale config and style guides

* Add Vale to Makefile
2022-05-18 14:45:25 -07:00
Niraj Tolia
ad15968837
Add docs template (#40)
* Add Dockerfile and Makefile for docs

* New Docusaurus project

* Remove blog from docs

* Add missing package-lock.json

* .PHONY
2022-05-16 22:44:49 -07:00