Commit Graph

38 Commits

Author SHA1 Message Date
Tessa Walsh
d5c3a8519f
Add crawler Use Sitemap option to Browsertrix Cloud (#978)
* Add user-guide docs for Use Sitemap option
---------

Co-authored-by: Henry Wilkinson <henry@wilkinson.graphics>
2023-07-19 13:57:52 -04:00
Henry Wilkinson
d9e73fcbc3
Reorder Limits section (#966)
* Reorder Limits section

- Minor text change to section names
  - "Limit Per Page" → "Per-Page Limits"
  - "Limit Per Crawl" → "Per-Crawl Limits"

* Reorder limits section in documentation
2023-07-08 08:54:30 -07:00
Anish Lakhwara
c5803dcda0
feat: configure kubectl through ansible (#948)
Co-authored-by: Anish Lakhwara <anish+git@lakhwara.com>
2023-07-07 09:15:18 -07:00
Anish Lakhwara
e1d6de21a0
docs: ansible deploy docs reflect expected env var names (#946)
Co-authored-by: Anish Lakhwara <anish+git@lakhwara.com>
2023-07-06 21:57:19 -07:00
Henry Wilkinson
ac4716614e
Minor gramatical changes to documentation (#919) 2023-07-04 17:14:49 -04:00
Tessa Walsh
bd6dc79449
Add frontend support for auto-adding collections to workflows (#916)
- Adds collections search and list to workflow editor
- Adds collections to workflow details component
- Adds namePrefix filter to backend GET /orgs/{oid}/collections endpoint to support case-insensitive searching of collections
- Adds documentation for new setting

---------

Co-authored-by: Henry Wilkinson <henry@wilkinson.graphics>
2023-06-12 18:18:05 -07:00
Henry Wilkinson
79703baa69
Org Settings documetation & Getting Started docs page updates 2023-06-11 17:39:16 -04:00
Henry Wilkinson
8477919989
Adds all workflow settings to the user docs with descriptions (#894)
Co-authored-by: Tessa Walsh <tessa@bitarchivist.net>
2023-06-08 14:28:58 -04:00
Henry Wilkinson
d286555396
Adds initial version of the documentation style guide (#891)
* Adds initial version of the documentation style guide

* Adds a note about adding new pages

* Instructs users about where to edit the `nav:` for the section

* Adds acronym rule clarification
2023-06-07 16:54:49 -07:00
sua yoo
965aa7ff90
Update backend local development docs (#884)
* docs refactor:
- add local deployment guide local-dev-setup.md
- deploy/local.md focuses only on deployment with latest release, links to local-dev-setup.md
for local image deployment
- add nav to mkdocs.yml to ensure correct order of pages
- update microk8s specific info
- update minikube specific info

---------
Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>
2023-05-25 09:50:56 -07:00
Henry Wilkinson
81e4b6c2cf
Revert docs body font to Inter (#790)
* Revert docs body font to Inter

- Adds Inter V4 Beta variable font files
  - Main docs title in the nav retains Recursive as its typeface
- Updates text styling to use app-aligned typography
- Updates code blocks, now with distinct borders!
- Cleans up code blocks, moves like parts together

* font-weight fix

- Aligns with app font weight for titles
2023-04-22 08:46:21 -07:00
Henry Wilkinson
d50fab67a9 Link accessibility improvements
- Nav bar text is now 20% higher opacity, hover state also differentiated with weight
- In-body links are now underlined
- Lightened BG colour and darkened link colour — now achieves an APCA score of 84!
2023-04-11 19:51:48 -04:00
Henry Wilkinson
128aa89d33 Adds the specific icons currently required
- Updates writing docs page regarding adding icons
2023-04-10 18:58:24 -04:00
Henry Wilkinson
ec324799c9 removes icons 2023-04-10 03:05:32 -04:00
Henry Wilkinson
8e8f59ec13 Updates main & code block background colors 2023-04-07 00:06:26 -04:00
Henry Wilkinson
8d60984760 Typography updates
- Sets Recursive as the main typeface for code and text!
- Adjusts variable axes and sets stylistic alternates accordingly.
- Self hosts the font
2023-04-06 23:28:23 -04:00
Henry Wilkinson
ab8088aec4 merge main into update 2023-04-06 18:39:23 -04:00
Henry Wilkinson
25800b924b update admonition icons 2023-04-06 17:49:29 -04:00
Henry Wilkinson
63bbe4c1ae Adds bootstrap icons to the docs repo 2023-04-06 17:20:13 -04:00
Henry Wilkinson
0a1f5eff8e
Docs: adds mkdocs features, adds theming (#728)
* Add stylesheet & mkdocs features

- Adds a custom stylesheet & brand colours
- Adds Recursive as the code font
- Adds repo info to the nav bar
- Adds auto tracking ID links for deep linking to sections as users scroll the page
- Index pages are now a part of their section as determined by their H1
- Removes mkdocs info from future footer

* Reorganize content

- Renames "Dev" to "Develop" for improved navigation labels
- Adds links to tools the first time they're mentioned
- Rewords part of the homepage
- Hides section navigation on the homepage (now we don't have a blank section nav bar!
- Adds some syntax highlighting
- Removes some manual word wrapping — this was done very rarely / inconsistently

* Rename "Developer Docs" index page

- Better title for sidebar

* Update docs.md

- Adds links to tools
- Adds future docs style guide section
- Updates name and makes it an H1

- Replaces hyphens on the homepage with em dashes

* deployment index page: changed title, removed non-k8s section, cleaned up intro
* develop index page: changed title
fixed typo on main page

---------

Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>
2023-04-06 02:44:19 -07:00
Henry Wilkinson
68ec47cb7f Moves deployment docs back to the root docs directory
- Replaces hyphens on the homepage with em dashes
2023-03-31 00:06:45 -04:00
Henry Wilkinson
96afa408d9 Update docs.md
- Adds links to tools
- Adds future docs style guide section
- Updates name and makes it an H1
2023-03-27 02:46:50 -04:00
Henry Wilkinson
2afc13e35a Rename "Developer Docs" index page
- Better title for sidebar
2023-03-27 02:19:41 -04:00
Henry Wilkinson
f6bab4f26c Reorganize content
- Renames "Dev" to "Develop" for improved navigation labels
- Deployment docs are now located under a larger "Development" section (fewer nav bar choices & realistically I think anyone who wants to do one is going to be referring to the other)
- Adds links to tools the first time they're mentioned
- Rewords part of the homepage
- Hides section navigation on the homepage (now we don't have a blank section nav bar!
- Adds some syntax highlighting
- Removes some manual word wrapping — this was done very rarely / inconsistently
2023-03-27 02:11:41 -04:00
Henry Wilkinson
7576ac8423 Add stylesheet & mkdocs features
- Adds a custom stylesheet & brand colours
- Adds Recursive as the code font
- Adds repo info to the nav bar
- Adds auto tracking ID links for deep linking to sections as users scroll the page
- Index pages are now a part of their section as determined by their H1
- Removes mkdocs info from future footer
2023-03-27 02:06:34 -04:00
Francis Kayiwa
3ba77f0ed2
ansible: rocky firewall (#635)
* modify the template file to highlight optional host that stores WAC
files

* numerically reorder the tcp ports - fix the 404's on the documentation

* add a configuration file - this allows automatic selection of inventory directory

* provide better examples on documentation
2023-02-24 17:28:21 -08:00
D. Lee
d15e6c8ad8
Fix doc to build a local image for microk8s (#594)
- add push to registry cmd
- update to frontend_* and backend_*
2023-02-14 16:10:04 -08:00
Ilya Kreymer
875364c05a docs: tweak ansible deployment docs 2023-01-11 22:33:28 -08:00
Francis Kayiwa
b0f1379e42
add digital ocean documentation (#421)
* add digital ocean documentation

* remove microk8s role

* use a single playbook to install microk8s

* use inventory hostname

* use a host_ip for endpoint so not to clash with domain

* add RedHat control loops

* add microk8s documentation

* enable permissive mode for redhat
2023-01-11 21:57:17 -08:00
Ilya Kreymer
ad07b6ab43
docs: CHANGES: fix typo, begin changelist for 1.2.0 (#410)
scripts: fix scripts to use plain docker build
docs: update local deployment info to include k3s
2022-12-12 20:32:35 -08:00
Henry Wilkinson
57ec6d1be2
Minor docs style updates (#409)
* Minor style updates

- Uses the Material `teal` colour which seems to be a close match... This will be changed later once I do more branding things with a proper theme override
- Adds a monochrome version of the current Browsertrix Cloud logo.
- Fixes typo :P
2022-12-12 18:15:12 -08:00
Ilya Kreymer
e2025dac4b docs:
- local deploy update: add collapsible details blocks for vendor-specific instructions, move installing section before running
- add missing docs on how to run docs
- fix doc typos
2022-12-08 17:59:24 -08:00
Ed Summers
a656ab512b
fix link (#404) 2022-12-07 10:00:00 -08:00
Ilya Kreymer
6e81b44ff8 docs: fix typos in production, missing TODO in user-guide section 2022-12-06 15:24:10 -08:00
Ilya Kreymer
0aa09be8c3
README + CHANGES + doc tweaks for 1.1.0 release (#402)
- update README + docs with deprecation of non-k8s deployment
- add CHANGES.md
- bump version to 1.1.0
2022-12-06 12:27:27 -08:00
Ilya Kreymer
9624cb6007 docs: add CNAME to keep correct domain 2022-12-06 00:45:57 -08:00
Ilya Kreymer
829548af0f doc tweaks:
- fix typos in docs
- update prod deployment info
- update minikube info
- add info on how to run with local images
- bump version to 1.1.0-beta.3 for testing multiarch build
2022-12-05 18:14:19 -08:00
Henry Wilkinson
a74d88dcda
mkdocs setup (deploy, dev, user-guide) (#375)
* Initial docs move
* Setup mkdocs
* Adds instructions for building docs
* add new deployment docs, local and prod
* set up three sections: deployment, dev and user guide
* remove old deployment docs
* ci: mkdocs gh-pages publish

Co-authored-by: sua yoo <sua@suayoo.com>
Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>
2022-12-05 16:41:37 -08:00