32 Commits

Author SHA1 Message Date
Niraj Tolia
e5701df8c6
Add docs landing page back (#1537)
## Description

This reverts commit 18bc6b05e10df44083ed67010fc62ea9b0a2efd1 in prep for bringing the blog
back to docs.

## Type of change

- [x] 🗺️ Documentation
2022-11-16 22:48:43 +00:00
Niraj Tolia
2524c67540
Add a sitemap to the docs site (#1450)
## Description

Configure a sitemap for search engine indexing

## Type of change

<!--- Please check the type of change your PR introduces: --->
- [x] 🗺️ Documentation

## Test Plan

- [x] 💪 Manual
2022-11-04 08:09:56 +00:00
Niraj Tolia
2ad9eb531c
Use same gtag as website (#1431)
## Description

Follow Google recommendations for single gtags

## Type of change

- [x] 🗺️ Documentation
2022-11-03 07:19:15 +00:00
Niraj Tolia
f4828705c9
Actually enable Google Analytics for Corso docs (#1409)
## Description

We were missing the actual plugin and did not have configuration for the right
plugin type.

## Type of change

- [x] 🐛 Bugfix
- [x] 🗺️ Documentation
2022-11-01 18:40:28 +00:00
Niraj Tolia
18bc6b05e1
Remove Corso docs landing page (#1367)
## Description

Given that we have a website, this change removes the Docs landing page

## Type of change

- [x] 🗺️ Documentation

## Test Plan

- [x] 💪 Manual
2022-10-29 01:29:42 +00:00
Niraj Tolia
af35fb51b6
Add Twitter card for docs (#1330)
## Description

Adds metadata for Twitter cards to Docusaurus

## Type of change

- [x] 🗺️ Documentation
2022-10-26 23:08:19 +00:00
Niraj Tolia
77446c030a
Remove docs reference to discussions (#1297)
## Description

Now disabled on Github

## Type of change

- [x] 🗺️ Documentation
2022-10-22 02:13:35 +00:00
Niraj Tolia
78a605ec5c
Download instructions (#1276)
## Description

Explicit download instructions

## Type of change

- [x] 🗺️ Documentation
2022-10-21 07:18:33 +00:00
Niraj Tolia
b4e3ea0e05
Simplify docs on how to run Corso (#1239)
## Description

Simplify docs on how to run Corso

- Add Docker and Windows binary instructions
- Add synced tabs
- Tweak tabs content to allow for copy-paste

## Type of change

- [x] 🗺️ Documentation
2022-10-20 02:01:37 +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
Abin Simon
5e5ccc1dec
Drop search in docs (#1207)
## Description

It was causing issues with building docs locally via make.
This reverts commit 4be8e825ada0b6e4d0e4372446a0f097c128896f.

## Type of change

<!--- Please check the type of change your PR introduces: --->
- [ ] 🌻 Feature
- [ ] 🐛 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. -->
* #<issue>

## Test Plan

<!-- How will this be tested prior to merging.-->
- [ ] 💪 Manual
- [ ]  Unit test
- [ ] 💚 E2E
2022-10-19 05:58:25 +00:00
Abin Simon
4be8e825ad
Add local search in docs (#1165)
## Description

Adds a simple local search in docs based on https://github.com/easyops-cn/docusaurus-search-local . I always found myself looking for a search button and thought it would be a good idea to add it even thought it might not be able to do some fancy searches.
![2022-10-14-11-30-13](https://user-images.githubusercontent.com/14259816/195773364-7448592d-ce6e-47b5-8a84-96ce71b9af95.png)

## Type of change

<!--- Please check the type of change your PR introduces: --->
- [ ] 🌻 Feature
- [ ] 🐛 Bugfix
- [x] 🗺️ 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. -->
* #<issue>

## Test Plan

<!-- How will this be tested prior to merging.-->
- [x] 💪 Manual
- [ ]  Unit test
- [ ] 💚 E2E
2022-10-18 04:30:36 +00:00
Abin Simon
1793cc3757
Setup CI for release (#1052)
* Setup CI for release

* Initial commit of CHANGELOG.md

* Pin vale and markdownlint-cli to current versions

* Update branch name for CI

* Pull request workflow job
2022-10-10 11:00:55 +05:30
Niraj Tolia
4d02650f99
Add Google Analytics to webpages (#934)
## Description

Add Google Analytics to docs and website

This can only be tested in production for docs but it looks like the HTML does the right thing.

## Type of change

- [x] 🌻 Feature


## Test Plan

- [x] 💪 Manual
2022-09-23 15:37:12 +00:00
Niraj Tolia
0ead769e83
Enable dark/light mode controls (#940)
## Description

Enable dark/light mode controls.

This also reads the system preferences.

## Type of change

<!--- Please check the type of change your PR introduces: --->
- [x] 🗺️ Documentation


## Test Plan

<!-- How will this be tested prior to merging.-->
- [x] 💪 Manual
2022-09-22 22:55:12 +00:00
Niraj Tolia
a838be583d
Update Corso logos in the docs (#933)
## Description

- Add Corso logo to the docs footer
- Update Corso logo used in the header

## Type of change

<!--- Please check the type of change your PR introduces: --->
- [x] 🐹 Trivial/Minor

## Test Plan

<!-- How will this be tested prior to merging.-->
- [x] 💪 Manual
2022-09-22 15:45:26 +00:00
Niraj Tolia
c9224aa773
Unify colors between docs and the website (#932)
## Description

Unify colors between docs and the website.

This PR also brings some more color to the homepage

## Type of change

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

## Test Plan

- [x] 💪 Manual
2022-09-22 06:50:26 +00:00
Niraj Tolia
bdecdbbfe9
Update docs homepage (#929)
## Description

Update docs homepage

- Tagline
- Images
- Pillars
- Discord, Twitter, Website links

## Type of change

- [x] 🌻 Feature

## Test Plan

- [x] 💪 Manual
2022-09-22 00:29:58 +00:00
Georgi Matev
9602360b5b
Adds docusorus-plugin-sass plugin and enhances the existing theme (#786)
## Description

Enhanced styling for the docs theme. Will be used for the tables for the custom autogenerated cli docs 

## 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-06 23:33:23 +00:00
Niraj Tolia
4abc4edfcc
Add am image zoom plugin for Docusaurus (#666) 2022-08-29 17:13:42 +00:00
Georgi Matev
9f6b1bc1b8
Docs structure and initial content (#658)
* Clean up tree structure and add proper logo

* Proper logo files

* Initial docs

* Pick up new page after merging main

* Apply suggestions from code review

Some nits

Co-authored-by: Niraj Tolia <ntolia@users.noreply.github.com>

* Quash a bunch of Vale prose linter errors, warnings, and suggestions.

* PR Review feedback
* Simplified mount folders
* Cleaned up windows container
* Hid `latest` release tag

* Review feedback: Link to repo page

* Better arrow symbol

Co-authored-by: Niraj Tolia <ntolia@users.noreply.github.com>

* Clarify sentence

* Update README.md

* Reframing focus to M365

* More linting

* Use only MD files

Co-authored-by: Niraj Tolia <ntolia@users.noreply.github.com>
2022-08-26 20:45:50 -07:00
Niraj Tolia
4bf6e92098
Docs text and build fixes (#613)
* Fix Lint warnings in the linters docs file

* Fix broken links (`make build` is no longer broken)
2022-08-19 09:46:24 -07:00
Niraj Tolia
06608be38e
Minor docs tweaks (#71)
- Better broken link error checking
- Link to Mermaid
2022-05-24 12:39:08 -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
df23d2238a
Add support for dark mode for Corso docs (#63) 2022-05-20 12:52:58 -07:00
Niraj Tolia
533a9ebb09
Add edit ability (via GitHub) to Corso docs (#55) 2022-05-20 11:02:28 -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
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
Keepers
5f8d040b40
adds docs/CLI.md (#28)
* adds docs/CLI.md

Introduces the cli command documentation.

* extending cli.md with design discussion

* migrate cli.md into docusaurus docs (#11)

Move the CLI.md file into docusaurus so that it appears
as part of the documentation page.

* remove cli version, settings.json (#11)

Remove /.vscode/settings.json and the versioning info from
/docs/cli.md.
2022-05-19 16:08:01 -06:00
Niraj Tolia
8812f4bc9b
Customize options for Corso (#48)
Uses a Noun project icon for now. Color #776A60 used with
https://thenounproject.com/icon/cane-corso-4559376/

Co-authored-by: Vaibhav Kamra <vkamra@alcion.ai>
2022-05-18 14:22:38 -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