maurice/snix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(tvix): create Welcome + Contributing sections

Browse source 
A lot of this content needs to be duplicated from the monorepo’s root
directory. However, some of the content was not relevant or could have
been more condensed in descriptions or split up for consumption that
also matched the styles of some other library documentation I had been
looking at for examples. I wanted to add the new access to Admonish
callouts but also aimed at the readablitiy in one’s text editor for the
user that needs to `cat` the docs.

In the future, a “Introduction” page would be nice to add to “Welcome”,
but I don’t think that is as clear.

Change-Id: Ibfc169c5fc3501d7eeb9a76423c6f64cd68897aa
Reviewed-on: https://cl.tvl.fyi/c/depot/+/11869
Tested-by: BuildkiteCI
Reviewed-by: flokli <flokli@flokli.de>
This commit is contained in:
toastal 2024-06-25 18:28:06 +07:00
parent fbce56b849
commit ade0781416
5 changed files with 288 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

33
tvix/docs/src/contributing/email.md Normal file
View file

@ -0,0 +1,33 @@
# Submitting changes via email
With SSO & local accounts, hopefully Tvix provides you a low-friction or
privacy-respecting way to make contributions by means of
[TVL’s self-hosted Gerrit][gerrit]. However, if you still decide differently,
you may submit a patch via email to `depot@tvl.su` where it will be added to
Gerrit by a contributor.
Please keep in mind this process is more complicated requiring extra work from
both us & you:
* You will need to manually check the Gerrit website for updates & someone will
need to relay potential comments to/from Gerrit to you as you won’t get
emails from Gerrit.
* New revisions need to be stewarded by someone uploading changes to Gerrit
on your behalf.
* As CLs cannot change owners, if you decide to get a Gerrit account later on
existing CLs need to be abandoned then recreated. This introduces more churn
to the review process since prior discussion are disconnected.
Create an appropriate commit locally then send it us using either of these
options:
* `git format-patch`: This will create a `*.patch` file which you should email to
us.
* `git send-email`: If configured on your system, this will take care of the
whole emailing process for you.
The email address is a [public inbox][].
[gerrit]: ../contributing/gerrit.html
[public inbox]: https://inbox.tvl.su/depot/