Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2025-09-19 20:44:52 -04:00
Code Issues Projects Releases Packages Wiki Activity

docs: improve developer documentation for folks new to the codebase

Browse source 
* Correct example invocation of aws cli

* Add warning to Helm Intellisense recommendation

* Link code conventions in PR guidelines

* Tighten debugd README

* cmake is not used for building debugd anymore, remove references to it

* make the debug-cluster workflow the authoritative source for cdbg usage - don't replicate the same instructions in different places

* Document that Bazel eats a lot of RAM
This commit is contained in:
Markus Rudy 2023-11-17 19:16:52 +01:00 • committed by GitHub
parent e51513985a
commit 69c64d6c69
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 11 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

3
dev-docs/workflows/build-develop-deploy.md
View file

@ -5,6 +5,7 @@ The following are instructions for building all components in the constellation
Prerequisites:
* 20GB (minimum), better 40 GB disk space (required if you want to cross compile for all platforms)
* 16GB of unutilized RAM for a full Bazel build.
* [Latest version of Go](https://go.dev/doc/install).
* Unless you use Nix / NixOS: [Bazelisk installed as `bazel` in your path](https://github.com/bazelbuild/bazelisk/releases).
* We require Nix to be installed. It is recommended to install nix using the [determinate systems installer](https://github.com/DeterminateSystems/nix-installer) (or to use NixOS as host system).
@ -55,7 +56,7 @@ To provision the constellation cluster on the provider infrastructure, please au
E.g. AWS:
```sh
aws login
aws configure
```
For more details, see [here](https://docs.edgeless.systems/constellation/getting-started/install#set-up-cloud-credentials).

2
dev-docs/workflows/dev-setup.md
View file

@ -37,7 +37,7 @@ Additionally, we use the [Redhat YAML formatter](https://marketplace.visualstudi
* ShellCheck (timonwong.shellcheck): Shell script linter
* vscode-proto3 (zxh404.vscode-proto3): Protobuf language support
* Code Spell Checker (streetsidesoftware.code-spell-checker): Highlights potential spelling mistakes
* Helm Intellisense: (Tim-Koehler.helm-intellisense): Syntax highlighting and more for Helm charts
* Helm Intellisense: (Tim-Koehler.helm-intellisense): Syntax highlighting and more for Helm charts (not available on [Open VSX Registry](https://open-vsx.org/))
* YAML (redhat.vscode-yaml): YAML language support. (Does not work with Helm charts)
* markdownlint (DavidAnson.vscode-markdownlint): Markdown linter

2
dev-docs/workflows/pull-request.md
View file

@ -8,7 +8,7 @@ For pull requests, we employ the following workflow:
1. Fork the repository to your own GitHub account
2. Create a branch locally with a descriptive name
3. Commit changes to the branch
4. Write your code according to our development guidelines
4. Write your code according to our [development guidelines](../conventions.md)
5. Push changes to your fork
6. Clean up your commit history
7. Open a PR in our repository and summarize the changes in the description