28 Commits

Author SHA1 Message Date
github-actions[bot]
8ab5d5c112
Docs Auto-Generation (#1023)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2022-10-03 23:53:39 +00:00
github-actions[bot]
5e4b823663
Docs Auto-Generation (#1008)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2022-09-30 22:40:59 +00:00
Georgi Matev
fe2516b9ba
Fix all Vale [error] level lint issues and all markdownlint issues (#997)
## Description

* fixes all `markdownlint` issues, includeing autogenerated docs
* fixes [error] level Vale problems 
*
## Type of change

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

## Issue(s)

## Test Plan

<!-- How will this be tested prior to merging.-->
- [x] 💪 Manual
- [ ]  Unit test
- [ ] 💚 E2E
2022-09-30 07:31:58 +00: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
Niraj Tolia
c4abcd24bc
Fix broken docs links (#936)
## Description

Fix broken docs links

This was caught by `make build` and should ultimately be a part of the build process.

## Type of change

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

## Test Plan

<!-- How will this be tested prior to merging.-->
- [x] 💪 Manual
2022-09-22 22:56:23 +00:00
github-actions[bot]
b30d5f15cc
Docs Auto-Generation (#859)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2022-09-21 01:18:32 +00:00
github-actions[bot]
5f85b6f061
Docs Auto-Generation (#803)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2022-09-09 14:38:58 +00:00
github-actions[bot]
8fe8dfeee6
Docs Auto-Generation (#746)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2022-09-03 01:43:46 +00:00
github-actions[bot]
7d5e72925a
Docs Auto-Generation (#618)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2022-09-01 00:24:20 +00:00
Niraj Tolia
245bb6e73e
Misc doc changes (#667)
* Bounce package.json verison to 0.1.0

* Docs cleanup driven by Vale

* Clarifying language

* Clarify that permissions bit is important

* End of line white space linter warnings

* Straighten what seemed like awkward constructs in prerequisites

* Sync up with `docs/intro.md`

Co-authored-by: Georgi Matev <gmatev@alcion.ai>
2022-08-31 00:23:42 +00:00
ashmrtn
c3e89db0df
Lint doc for wsl (#678)
Some tips and examples on coexisting with the wsl linter
2022-08-29 22:46:57 +00:00
ashmrtn
68a1d8e868
Revisions left out from #541 (#677)
Revisions left out from #541
2022-08-29 22:12:26 +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
Vaibhav Kamra
350b148155
Instructions on running tests (#588)
* Add testing instructions

* Update link
2022-08-18 20:09:40 +00:00
ashmrtn
a43a98e8ad
Document installing/running/interpreting linters (#541)
Also minor documentation for import formatting expectations.
2022-08-12 14:20:53 -07:00
Keepers
0cb11e0cc5
clean up env var tester func for multiple slices (#508) 2022-08-12 00:08:00 +00:00
Danny
97113aa80b
Folder Granularity scope Added to Collections Retrieval (#482)
Backup function `DataExchangeCollections` supports the ability to backup a single file using the `selectors` package. Support files and documentation updated accordingly
2022-08-05 11:20:36 -04:00
Keepers
9326690338
autopopulate cli markdown on ci build (#453) 2022-08-04 16:46:14 -06:00
Niraj Tolia
301e7bd10e
Add minimal S3 configuration for Corso (#158) 2022-06-08 09:47:55 -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
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
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
c3c3613a71
Docs: Allow for a clean run of make check (#57) 2022-05-19 14:32:30 -07:00
Niraj Tolia
49aa63c349
Remove sample docs (#56) 2022-05-19 13:32:03 -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