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
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
Georgi Matev
802001513f
Some quality of life docs tooling improvements ( #664 )
2022-08-26 19:03:36 -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
9755b7a72b
Docs upgrades ( #596 )
2022-08-19 16:15:14 +00: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
06608be38e
Minor docs tweaks ( #71 )
...
- Better broken link error checking
- Link to Mermaid
2022-05-24 12:39:08 -07:00
Niraj Tolia
5739f903ff
Docs changes for GitHub Actions ( #69 ) ( #70 )
2022-05-24 12:38:48 -07:00
Niraj Tolia
7f82dd5837
Catch typos in docs-related JSON ( #66 )
2022-05-20 13:22: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
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
965d4fae36
Add git to the docs Docker image ( #53 )
2022-05-20 11:02:20 -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
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
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
5f7f5736ed
Add docs and commands to setup the container image ( #49 )
2022-05-19 10:29:25 -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
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
