about summary refs log tree commit diff
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2024-08-27 r/8595 docs: add notes about importing existing projects into depotVincent Ambo1-0/+91
Change-Id: Idc8572ae68eb9513c6c63642737ce8fd004ee67e Reviewed-on: https://cl.tvl.fyi/c/depot/+/12325 Reviewed-by: azahi <azat@bahawi.net> Tested-by: BuildkiteCI Autosubmit: tazjin <tazjin@tvl.su> Reviewed-by: benjaminedwardwebb <benjaminedwardwebb@gmail.com>
2024-06-15 r/8281 docs: move Registration to the top; minor rewordtoastal1-17/+24
When trying to follow Review documentation, I got tripped up on the “Gerrit setup” section that was asking about SSH keys since I hadn’t yet gotten an account setup but the registration setion was near the bottom of the document despite being a requirement for setting up Gerrit. Included words specifying SSO, specifies that the TVL account is an alternative method, & commit→patch since you send a patch with the commit. Change-Id: I465c8a79979b368ab01bcebdc7e5ef16e65dd341 Reviewed-on: https://cl.tvl.fyi/c/depot/+/11823 Reviewed-by: flokli <flokli@flokli.de> Tested-by: BuildkiteCI
2024-03-19 r/7744 docs(CONTRIBUTING): update character length limitFlorian Klink1-1/+1
Actual config change already done in https://cl.tvl.fyi/11196, this updates the documentation. Change-Id: I3cf986619cdb8f5a48ad5d07050e56ebdc99788c Reviewed-on: https://cl.tvl.fyi/c/depot/+/11210 Tested-by: BuildkiteCI Autosubmit: flokli <flokli@flokli.de> Reviewed-by: sterni <sternenseemann@systemli.org>
2023-10-16 r/6822 docs(REVIEWS): update commit-msg hook instructionsFlorian Klink1-1/+2
Gerrit instructions now recommend fetching the commit-msg hook via HTTP in all three cases, we should do the same. Change-Id: I12d5784ccacd3ea68fb81fc15508b209a22cd2c1 Reviewed-on: https://cl.tvl.fyi/c/depot/+/9745 Autosubmit: flokli <flokli@flokli.de> Tested-by: BuildkiteCI Reviewed-by: lukegb <lukegb@tvl.fyi>
2023-09-12 r/6583 docs(REVIEWS): point people to signup.tvl.fyi for account creationVincent Ambo1-12/+1
Rather than invoking the old shell script, people can now use the web UI to create the entry. Change-Id: Ic1b065d219fde9977bb1d8ee59ce7ac5f27e2e29 Reviewed-on: https://cl.tvl.fyi/c/depot/+/9306 Autosubmit: tazjin <tazjin@tvl.su> Tested-by: BuildkiteCI Reviewed-by: flokli <flokli@flokli.de>
2023-08-21 r/6515 docs(docs/REVIEWS): explain disadvantages of patch submissionFlorian Klink1-3/+16
There's been some patch submissions gone wrong recently, and piling up in Gerrit. Describe a bit more why patch submission via email is less convenient for both sides. Change-Id: I9dfb5e912511a8b5b828f443c25d5cf36ec5acea Reviewed-on: https://cl.tvl.fyi/c/depot/+/9089 Tested-by: BuildkiteCI Autosubmit: flokli <flokli@flokli.de> Reviewed-by: tazjin <tazjin@tvl.su> Reviewed-by: raitobezarius <tvl@lahfa.xyz>
2023-06-10 r/6260 docs(REVIEWS.md): improve gerrit workflow explanationDavHau1-3/+6
Change-Id: I03c156c72831931f5a1984b6ff80bdc239f75e8e Reviewed-on: https://cl.tvl.fyi/c/depot/+/8726 Tested-by: BuildkiteCI Reviewed-by: tazjin <tazjin@tvl.su>
2023-06-06 r/6239 feat(docs): mention OIDC providers in registration instructionsLinus Heckemann1-2/+4
Change-Id: I698c7b6b1f5f5202c49fcbe026782eb4692d99d3 Reviewed-on: https://cl.tvl.fyi/c/depot/+/8706 Tested-by: BuildkiteCI Reviewed-by: flokli <flokli@flokli.de> Reviewed-by: tazjin <tazjin@tvl.su> Reviewed-by: sterni <sternenseemann@systemli.org>
2023-02-10 r/5845 docs(REVIEWS): update scp commandAlyssa Ross1-1/+1
cl.tvl.fyi only supports the legacy scp protocol, not the sftp protocol that recent versions of OpenSSH now use by default. So we need to pass -O to tell it to use scp. Cc: Vincent Ambo <mail@tazj.in> Change-Id: I2dcae77fef9126f4f8eebfa574c5a345a5c56615 Reviewed-on: https://cl.tvl.fyi/c/depot/+/8039 Reviewed-by: flokli <flokli@flokli.de> Reviewed-by: tazjin <tazjin@tvl.su> Tested-by: BuildkiteCI
2022-12-27 r/5507 docs: change email address mentions to depot@tvl.suVincent Ambo2-6/+6
This is the new address which leads to the public inbox at inbox.tvl.su Change-Id: I45d98a373b8acda49b05c4f74669ffb9ad1f1a3c Reviewed-on: https://cl.tvl.fyi/c/depot/+/7632 Tested-by: BuildkiteCI Reviewed-by: flokli <flokli@flokli.de>
2022-12-26 r/5490 chore(tools): remove depot-scanner & tvlcVincent Ambo1-0/+6
These are both unused things from a long time ago, which we don't need to keep around anymore. Their design doc has been marked as archived. Change-Id: Icd2744e511e78ec95ec8f39e5f79ed1fe98e9e4a Reviewed-on: https://cl.tvl.fyi/c/depot/+/7639 Autosubmit: tazjin <tazjin@tvl.su> Tested-by: BuildkiteCI Reviewed-by: flokli <flokli@flokli.de>
2022-10-19 r/5160 docs(REVIEWS.md): gerrit-for-github guide, warn about attention setsAdam Joseph1-0/+37
Change-Id: Ia20feacbb7394daaa1f1ed0d1e05c7441a187744 Signed-off-by: Adam Joseph <adam@westernsemico.com> Reviewed-on: https://cl.tvl.fyi/c/depot/+/7035 Reviewed-by: tazjin <tazjin@tvl.su> Tested-by: BuildkiteCI
2021-11-30 r/3121 docs(CONTRIBUTING): Mention new subtree commit typeVincent Ambo1-0/+1
See cl/4049 Change-Id: I583e4bcf88342a998d7a5a9fd92f73d0710ee2e9
2021-05-23 r/2618 chore: Replace remaining mentions of ##tvl[-dev] with #tvlVincent Ambo1-1/+2
... and fix the capitalisation of hackint Change-Id: I800aef75152d2dc77a33876888e36530143e9d3e Reviewed-on: https://cl.tvl.fyi/c/depot/+/3148 Tested-by: BuildkiteCI Reviewed-by: grfn <grfn@gws.fyi> Reviewed-by: sterni <sternenseemann@systemli.org>
2021-04-12 r/2497 refactor: Replace 'depotPath' with 'depot.path'Vincent Ambo1-1/+1
Instead of having two ways of accessing the path to the depot (one of which was stuttering, depot.depotPath) we settle on only one: depot.path. This was mostly used for NixOS module imports. Co-Authored-By: Florian Klink <flokli@flokli.de> Change-Id: I2c0db23383fc34f6ca76baaad4cc4af2d9dfae15 Reviewed-on: https://cl.tvl.fyi/c/depot/+/2962 Tested-by: BuildkiteCI Reviewed-by: grfn <grfn@gws.fyi> Reviewed-by: sterni <sternenseemann@systemli.org>
2021-04-11 r/2482 refactor(ops): Split //ops/nixos into different locationsVincent Ambo1-1/+1
Splits //ops/nixos into: * //ops/nixos.nix - utility functions for building systems * //ops/machines - shared machine definitions (read by readTree) * //ops/modules - shared NixOS modules (skipped by readTree) This simplifies working with the configuration fixpoint in whitby, and is overall a bit more in line with how NixOS systems in user folders currently work. Change-Id: I1322ec5cc76c0207c099c05d44828a3df0b3ffc1 Reviewed-on: https://cl.tvl.fyi/c/depot/+/2931 Tested-by: BuildkiteCI Reviewed-by: sterni <sternenseemann@systemli.org> Reviewed-by: glittershark <grfn@gws.fyi>
2021-03-27 r/2349 docs(REVIEWS): Update example commit for adding a new userVincent Ambo1-1/+1
This fixes https://b.tvl.fyi/issues/81 Change-Id: I5071b3edd81947b43f755e452a62b0129c6d07b6 Reviewed-on: https://cl.tvl.fyi/c/depot/+/2686 Tested-by: BuildkiteCI Reviewed-by: sterni <sternenseemann@systemli.org>
2021-01-18 r/2131 feat(todolist): use static slapd user data for knownUserssterni1-2/+2
Since the slapd data is static and generated using nix, we can simply move the user list into ops/users, so it's recognized by readTree and we can use it as ops.users both in ops/nixos/tvl-slapd and web/todolist as a general purpose user registry for depot. Update docs/REVIEWS.md as well. Change-Id: I35caaaab70a5578c47cedc7f33077dd513766290 Reviewed-on: https://cl.tvl.fyi/c/depot/+/2419 Tested-by: BuildkiteCI Reviewed-by: tazjin <mail@tazj.in>
2021-01-11 r/2073 docs(REVIEWS): change linked commit to one editing the slapd attrsetsterni1-1/+1
The old ldif file is no more, so linking a more up to date commit seems more helpful. Fixes #81. Change-Id: If9521020c6660e2ee1cfe0c9d9fce4bef2417ea8 Reviewed-on: https://cl.tvl.fyi/c/depot/+/2349 Reviewed-by: tazjin <mail@tazj.in> Tested-by: BuildkiteCI
2020-11-27 r/1932 fix(docs/REVIEWS): mention ##tvl-dev firstKane York1-1/+1
Change-Id: I34082af6249ba1c4d16b5b5d7f5f3fd78d4767bc Reviewed-on: https://cl.tvl.fyi/c/depot/+/2151 Reviewed-by: glittershark <grfn@gws.fyi> Reviewed-by: tazjin <mail@tazj.in> Tested-by: BuildkiteCI
2020-09-27 r/1820 docs(REVIEWS): Add a note about where to clone anonymouslyVincent Ambo1-1/+1
Change-Id: Ib56deb65c169f538bce3e3ef3223a3fb636e9c6e Reviewed-on: https://cl.tvl.fyi/c/depot/+/2004 Tested-by: BuildkiteCI Reviewed-by: ben <tvl@benjojo.co.uk>
2020-08-08 r/1614 docs(sparse): Add RFC design for depot worktree toolKane York1-0/+37
This is meant to be a high-velocity alternative to writing an entire FUSE filesystem to facilitate smaller checkouts of the depot. The script mostly works today, except that remote dependency detection is not set up. Change-Id: Idf9048df4f7ee39eaaedcdafcd9621f3d7479947 Reviewed-on: https://cl.tvl.fyi/c/depot/+/1644 Tested-by: BuildkiteCI Reviewed-by: edef <edef@edef.eu> Reviewed-by: tazjin <mail@tazj.in>
2020-07-26 r/1480 docs(REVIEWS): recommend remote.origin.push configKane York1-1/+14
Change-Id: I090841101b9ee0295aabb2097f953bf149f39a9d Reviewed-on: https://cl.tvl.fyi/c/depot/+/1403 Tested-by: BuildkiteCI Reviewed-by: lukegb <lukegb@tvl.fyi>
2020-07-17 r/1367 docs(REVIEWS): mention adding SSH keys to GerritAlyssa Ross1-2/+5
Change-Id: I75ecc0c9209b80ab3ae692013f4b075764e13218 Reviewed-on: https://cl.tvl.fyi/c/depot/+/1262 Tested-by: BuildkiteCI Reviewed-by: tazjin <mail@tazj.in>
2020-07-17 r/1365 docs(REVIEWS): use relative URL for tvl-slapdAlyssa Ross1-1/+1
This means that following the link locally is likely to do something far more useful. For example, C-c C-o in Emacs with markdown-mode will open the tvl-slapd file, rather than opening it in the browser. Change-Id: Icba3c195359855014fef17538a155656363a8b1e Reviewed-on: https://cl.tvl.fyi/c/depot/+/1261 Tested-by: BuildkiteCI Reviewed-by: tazjin <mail@tazj.in>
2020-07-01 r/1153 docs(REVIEWS): Update registration instructions for password hashesVincent Ambo1-4/+12
Change-Id: Idb8e5259f7b2a7105219fd3a21dc4b5774c44460 Reviewed-on: https://cl.tvl.fyi/c/depot/+/836 Reviewed-by: BuildkiteCI Reviewed-by: glittershark <grfn@gws.fyi> Tested-by: BuildkiteCI
2020-06-24 r/1073 chore: Update 'master -> canon' in various placesVincent Ambo1-3/+3
Change-Id: I901c023f707a0223af673c217c65434e26e2ab1f Reviewed-on: https://cl.tvl.fyi/c/depot/+/568 Reviewed-by: lukegb <lukegb@tvl.fyi>
2020-06-19 r/1043 fix(docs): Fix a few links that break in sourcegraph.nyanotech1-1/+1
I found a few links that seem to be absolute-path links designed for cgit. Replace them with relative links instead, so that they work within both sourcegraph and cgit. This commit handles this fix for the top-level README.md, and the ones within docs/. Change-Id: I842ffaf8ee893d3ed8490fe07c621d791d77d0ac Reviewed-on: https://cl.tvl.fyi/c/depot/+/496 Reviewed-by: tazjin <mail@tazj.in>
2020-06-17 r/1009 docs(REVIEWS): Update account creation note for new user listVincent Ambo1-4/+4
Change-Id: If657f4b49d16260b35f13a4124caa336bbe3124b Reviewed-on: https://cl.tvl.fyi/c/depot/+/449 Reviewed-by: riking <rikingcoding@gmail.com>
2020-06-17 r/1006 docs(REVIEWS): Add documentation for code reviews in GerritVincent Ambo2-11/+133
Adds a document with information about the review process, how to get an account, how to submit patches via email and so on. Change-Id: I7c266e063ef53ab6aa79dd2582bc0e4fa8dcf5c0 Reviewed-on: https://cl.tvl.fyi/c/depot/+/446 Reviewed-by: riking <rikingcoding@gmail.com>
2020-06-12 r/921 docs: Update contribution guidelines for Gerrit workflowVincent Ambo1-14/+21
Change-Id: Ia06886c61fbecd885d038f7e8f1d915cd4304547 Reviewed-on: https://cl.tvl.fyi/c/depot/+/90 Reviewed-by: tazjin <mail@tazj.in> Reviewed-by: riking <rikingcoding@gmail.com>
2019-12-20 r/246 docs: Update review address to depot@tazj.inVincent Ambo1-2/+2
2019-12-20 r/238 refactor: Fix a variety of filepaths for repo relayoutingVincent Ambo1-1/+2
This fixes readTree and the various project builds, as well as (hopefully) most documentation links inside of the projects.
2019-12-20 r/237 chore: Significantly restructure folder layoutVincent Ambo2-0/+147
This moves the various projects from "type-based" folders (such as "services" or "tools") into more appropriate semantic folders (such as "nix", "ops" or "web"). Deprecated projects (nixcon-demo & gotest) which only existed for testing/demonstration purposes have been removed. (Note: *all* builds are broken with this commit)