From 809939c8fd7439b0f1772365e33df72e4097c450 Mon Sep 17 00:00:00 2001 From: Harsh Singh <115187902+harshsinghcs@users.noreply.github.com> Date: Mon, 16 Oct 2023 18:29:15 +0530 Subject: [PATCH] doc: Update README.mds #827 (#855) * Update README.md Improved readme * Update README.md * Update README.md * removed please --------- Co-authored-by: Levente Orban --- README.md | 18 +++++++++--------- golang/pkg/crane/README.md | 6 +++--- web/crux/README.md | 4 ++-- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 205f39335b..9f3f5b3e0f 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Twitter Follow

-[dyrector.io](https://dyrector.io/) helps engineer & DevOps teams and individual developers to shift their focus from maintaining and setting up their containerized applications to developing their software. The platform achieves this by offering continuous delivery and version management capabilities to your OCI containers. +[dyrector.io](https://dyrector.io/) helps engineers & DevOps teams and individual developers to shift their focus from maintaining and setting up their containerized applications to developing their software. The platform achieves this by offering continuous delivery and version management capabilities to your OCI containers. Join our Discord and connect with other members to share and learn together. If you like the project, give us a Star. @@ -52,7 +52,7 @@ QA no longer needs help to test your services. Enable them to autonomously confi #### ⛵️ Container management across environments -Whether you're a developer or an indie hacker, bring your own infrastructure and manage all of your containers and applications from one place while our software is running either as a SaaS or on your infrastructure. +Whether you're a developer or an indie hacker, bring your own infrastructure and manage all your containers and applications from one place while our software is running either as a SaaS or on your infrastructure. #### 🛳️ CD & Version Management @@ -68,7 +68,7 @@ https://user-images.githubusercontent.com/9247788/219671903-41da385e-4f8f-4fba-a ## Key features -- Kubernetes, Docker and Podman support +- Kubernetes, Docker, and Podman support - Multi-instance deployment - Instant test environments from any branches - Environment management @@ -83,7 +83,7 @@ https://user-images.githubusercontent.com/9247788/219671903-41da385e-4f8f-4fba-a ## Hosted version (SaaS) -Besides the self-hosted instance, you can check out the platform's alpha at [app.dyrectorio.com](https://app.dyrectorio.com). The platform is still in the works, we might reset the database, so it's not recommended for production yet. In case you are interested about using dyrector.io in production, reach out to us via [email](hello@dyrector.io) and we'll set up a stable instance for you. +Besides the self-hosted instance, you can check out the platform's alpha at [app.dyrectorio.com](https://app.dyrectorio.com). The platform is still in the works, we might reset the database, so it's not recommended for production yet. If you are interested in using dyrector.io in production, reach out to us via [email](hello@dyrector.io) and we'll set up a stable instance for you. ## How it works @@ -105,22 +105,22 @@ If you have any questions, check out [FAQ](https://docs.dyrector.io/learn-more/f Also, follow us on GitHub Discussions, our [Blog](https://blog.dyrector.io), and on [Twitter](https://twitter.com/dyrectorio). You can chat with the team and other members on [Discord](https://discord.gg/pZWbd4fxga). -[dyrector.io](https://dyrector.io/) is Open Source - This repository, and most of our other open source projects, are licensed under the Apache 2.0. +[dyrector.io](https://dyrector.io/) is Open Source - This repository, and most of our other open-source projects, are licensed under Apache 2.0. Join our Discord and connect with other members to share and learn together. -Send a pull request to any of our open source repositories on Github. Check our contribution guide and our developers guide for more details about how to contribute. We're looking forward to your contribution! +Send a pull request to any of our open-source repositories on Github. Check our contribution guide and our developer's guide for more details about how to contribute. We're looking forward to your contribution! [![dyrectorio Discord server Banner](https://discordapp.com/api/guilds/797082431902449694/widget.png?style=banner2)](https://discord.gg/pZWbd4fxga) ## Contributing -The project can only accept contributions which are licensed under the [Apache License 2.0](LICENSE). For further information please see our [Contribution Guidelines](CONTRIBUTING.md). +The project can only accept contributions that are licensed under the [Apache License 2.0](LICENSE). For further information please see our [Contribution Guidelines](CONTRIBUTING.md). ## Releases -We use [semantic versioning](https://semver.org/), but shifted to the right, we don't bump major versions yet, until we reach beta phase. +We use [semantic versioning](https://semver.org/), but shifted to the right, we don't bump major versions until we reach the beta phase. -Minor version is raised if: +The minor version is raised if: - introduction of a braking API change (proto or HTTP) - new feature set is completed diff --git a/golang/pkg/crane/README.md b/golang/pkg/crane/README.md index bb58d2b60c..dce9a20cfd 100644 --- a/golang/pkg/crane/README.md +++ b/golang/pkg/crane/README.md @@ -68,9 +68,9 @@ Calculate coverage ## Deployment -Configuration will prioritize Environmental Variables, .env file, and defaults in this order with Environmental variables taking the highest priority. +The configuration will prioritize Environmental Variables, .env file, and defaults in this order with Environmental variables taking the highest priority. -Configuration will take place before starting up the application, and store the configuration options in a global variable, which can be accessed during runtime. Both crane and DAgent have their own configuration package to add their own defaults and/or add their own custom variables. When the variables are used to achieve similar functions, can be found in both projects, and have the same defaults; then it can be found in a "common" config package. Please see the common README.md for more. +Configuration will take place before starting up the application, and store the configuration options in a global variable, which can be accessed during runtime. Both Crane and DAgent have their own configuration package to add their own defaults and/or add their own custom variables. When the variables are used to achieve similar functions, can be found in both projects, and have the same defaults; then it can be found in a "common" config package. Please see the common README.md for more. | Environment variable | Description | Default | | ------------------------- | ----------------------------------------------- | --------------------- | @@ -85,7 +85,7 @@ Configuration will take place before starting up the application, and store the ### In-cluster -uses the current namespace's default serviceaccount +uses the current namespace's default service account Deploy crane into a cluster: diff --git a/web/crux/README.md b/web/crux/README.md index ec2662f1b9..0bd4f9a77e 100644 --- a/web/crux/README.md +++ b/web/crux/README.md @@ -7,12 +7,12 @@ information or check our official [documentation](https://docs.dyrector.io/) sit - `assets/` - TBD - `prisma/` - - `/migrations` - Your migration history is the story of the changes to your data model, and is represented by a this + - `/migrations` - Your migration history is the story of the changes to your data model and is represented by this folder with a sub-folder and migration.sql file for each migration. - `/proto` - gRPC proto files for communicate against the `agent` - `/src` - - `/app` - NestJS core application, each model has it's own folder with service, controller and repository serivces. + - `/app` - NestJS core application, each model has its own folder with service, controller, and repository services. - `builders/` - - `decorators/` - - `domain/` - Internal logic of the application