From f06be2b13b1de4f7cc6f6b8c5aa831f5454bc6cd Mon Sep 17 00:00:00 2001 From: Alexander Eimer Date: Thu, 28 Nov 2024 18:40:27 +0100 Subject: [PATCH 1/2] fix: developer-guide index --- .../modules/how-to/pages/index.adoc | 65 ++++++++++--------- 1 file changed, 33 insertions(+), 32 deletions(-) diff --git a/docs/developer-guide/modules/how-to/pages/index.adoc b/docs/developer-guide/modules/how-to/pages/index.adoc index 446291c..a2d8ace 100644 --- a/docs/developer-guide/modules/how-to/pages/index.adoc +++ b/docs/developer-guide/modules/how-to/pages/index.adoc @@ -11,7 +11,8 @@ Intention of this section is to provide guides for developers on how to perform This should help improve productivity and consistency in the development process. Be concise and to the point, assume the reader is competent in technology and tools used in the project. See -https://diataxis.fr/how-to-guides/[How-to guides in diataxis] for more information. +https://diataxis.fr/how-to-guides/[How-to guides in diataxis] +for more information. What to include:: @@ -35,10 +36,10 @@ External resources:: * https://github.com/spring-projects/spring-framework/wiki/Build-from-Source#import-into-your-ide[Spring Framework Build from Source] * https://go.dev/doc/contribute.html[Go Contributing Guide] -.Dependency Maintenance Routine Guide +.Dependency maintenance routine guide [example] ===== -Dependency Maintenance Routine Guide +Dependency maintenance routine guide This section provides a checklist for managing dependency updates in the software project. Regular maintenance ensures the incorporation of improvements, security fixes, and new features while maintaining system stability. @@ -46,44 +47,44 @@ Following a structured routine enables smooth handling of dependency updates and Process Overview: -. *Review Merge Requests by Dependabot / Renovate*: -- Check the changes proposed in the MR, including diff and commit messages. -- Understand the context and impact of the updates. +. *Review merge requests by dependabot / renovate*: +* Check the changes proposed in the MR, including diff and commit messages. +* Understand the context and impact of the updates. -. *Dependency Updates*: -- Verify the list of updated dependencies and their version changes. -- Review release notes for breaking changes, deprecations, or relevant fixes. +. *Dependency updates*: +* Verify the list of updated dependencies and their version changes. +* Review release notes for breaking changes, deprecations, or relevant fixes. -. *Assignment and Ownership*: -- Assign the MR to yourself or the appropriate team member for detailed review and feedback. +. *Assignment and ownership*: +* Assign the MR to yourself or the appropriate team member for detailed review and feedback. -. *Testing Updates*: -- Test changes locally or in a staging environment to ensure compatibility. -- Use automated pipelines for regression testing where applicable. +. *Testing updates*: +* Test changes locally or in a staging environment to ensure compatibility. +* Use automated pipelines for regression testing where applicable. -. *Pipeline Validation*: -- Verify the execution of pipelines and resolve any errors. -- Regularly monitor nightly tests for hidden issues. +. *Pipeline validation*: +* Verify the execution of pipelines and resolve any errors. +* Regularly monitor nightly tests for hidden issues. -. *Merge Changes*: -- Merge updates once testing and reviews are complete. -- Follow project-specific commit message guidelines. +. *Merge changes*: +* Merge updates once testing and reviews are complete. +* Follow project-specific commit message guidelines. -. *Dockerfile and CI Images*: -- Check and update Dockerfiles for base images and tools. -- Test and verify new image builds before deployment. +. *Dockerfile and CI images*: +* Check and update Dockerfiles for base images and tools. +* Test and verify new image builds before deployment. -. *Security Considerations*: -- Prioritize and assess the impact of security fixes. -- Coordinate urgent releases for high-severity vulnerabilities. +. *Security considerations*: +* Prioritize and assess the impact of security fixes. +* Coordinate urgent releases for high-severity vulnerabilities. -. *Helm Charts and Falco Rules*: -- Review changes in Helm charts and configuration. -- Test new or updated Falco rules and resolve false positives. +. *Helm charts and falco rules*: +* Review changes in Helm charts and configuration. +* Test new or updated Falco rules and resolve false positives. -. *Monitoring Post-Update*: -- Monitor for new errors or events caused by updates. -- Address issues promptly and iterate as needed. +. *Monitoring post-update*: +* Monitor for new errors or events caused by updates. +* Address issues promptly and iterate as needed. ===== ==== From b43220ab7adfcbd1be9cb8a4aad8f1d32d6fd53a Mon Sep 17 00:00:00 2001 From: Alexander Eimer Date: Thu, 28 Nov 2024 19:41:56 +0100 Subject: [PATCH 2/2] feat: write docs --- .../concepts/pages/branching-strategy.adoc | 65 ++------- .../pages/contribution-guidelines.adoc | 4 + .../concepts/pages/release-strategy.adoc | 136 ++---------------- .../modules/how-to/pages/debugging-guide.adoc | 12 +- .../modules/how-to/pages/get-access.adoc | 10 ++ .../modules/how-to/pages/local-setup.adoc | 10 ++ .../how-to/pages/maintenance-routines.adoc | 12 +- .../modules/how-to/pages/onboarding.adoc | 10 ++ .../modules/how-to/pages/release.adoc | 10 ++ .../modules/how-to/pages/rollback.adoc | 12 +- .../how-to/pages/configure-access-rights.adoc | 106 ++------------ .../how-to/pages/emergency-playbook.adoc | 4 + .../pages/recover-deleted-database.adoc | 134 ++--------------- .../modules/how-to/pages/snooze-alerts.adoc | 133 ++--------------- .../modules/concepts/pages/index.adoc | 28 ++++ .../modules/concepts/pages/security.adoc | 4 + .../pages/shared-responsibility-model.adoc | 4 + .../modules/how-to/pages/authentication.adoc | 85 ++--------- .../modules/how-to/pages/backup.adoc | 10 +- docs/user-guide/modules/how-to/pages/cli.adoc | 10 +- .../modules/how-to/pages/configure.adoc | 10 +- .../modules/how-to/pages/index.adoc | 62 +++++++- .../modules/how-to/pages/migration-guide.adoc | 10 +- .../modules/how-to/pages/setup-tools.adoc | 10 +- .../reference/pages/core-features.adoc | 10 +- .../modules/reference/pages/index.adoc | 51 +++++++ .../modules/reference/pages/java-sdk.adoc | 10 +- .../modules/reference/pages/openapi.adoc | 10 +- .../modules/reference/pages/releases.adoc | 10 +- .../tutorial/pages/deploy-first-app.adoc | 4 + .../modules/tutorial/pages/index.adoc | 102 +++++++++++++ 31 files changed, 470 insertions(+), 618 deletions(-) diff --git a/docs/developer-guide/modules/concepts/pages/branching-strategy.adoc b/docs/developer-guide/modules/concepts/pages/branching-strategy.adoc index 29950b8..0536bba 100644 --- a/docs/developer-guide/modules/concepts/pages/branching-strategy.adoc +++ b/docs/developer-guide/modules/concepts/pages/branching-strategy.adoc @@ -1,58 +1,11 @@ = Branching strategy -A branching strategy is a specific approach used by software development teams to manage the development of new features, bug fixes, and other updates within a version control system like Git. -It helps in organizing code changes and ensuring that the final product is stable and maintainable. -Several common branching strategies exist, each suitable for different types of projects and team structures. - -== Git Flow - -Git Flow is a popular branching strategy proposed by Vincent Driessen. -It introduces a structured branching model with multiple long-lived branches: -- `master`: The main branch containing stable code that is ready for production. -- `develop`: A branch for integrating features and fixes before merging them into the master. -- `feature/*`: Short-lived branches created from `develop` for developing new features. -- `release/*`: Branches for preparing releases; they help in final bug fixing and preparation before merging into `master` and `develop`. -- `hotfix/*`: Used to quickly address critical bugs found in production. - -This strategy is suitable for teams following a disciplined release cycle, ensuring stability and quality. - -== GitHub Flow - -GitHub Flow is a simpler, more streamlined approach predominantly used in continuous integration and deployment environments. -It involves the following: -- `main`: The default branch which always has deployable code. -- `feature/*` or `branch/*`: Short-lived branches created from `main` for new work. -Changes are committed to these branches and merged back into `main` through pull requests. -This ensures that the `main` branch is always stable and deployable. - -This strategy is ideal for teams needing rapid deployment and continuous delivery. - -== GitLab Flow - -GitLab Flow incorporates aspects of both Git Flow and GitHub Flow, providing flexibility based on an organization's deployment needs. -Key branches include: -- `main`: Production-ready code. -- `develop` or `staging`: Integration and testing environments. -- `feature/*`: Branches for new features or fixes, merged into `develop` or `staging`. -- Release management can involve tagging commits on the `main` branch or using specific release branches. - -This strategy works well for teams with complex workflows and multiple environments. - -== Trunk-Based Development - -In trunk-based development, all developers work on a single long-lived branch, commonly referred to as `trunk` or `main`. -Developers frequently commit their changes directly to this branch and continuously integrate their modifications. -This strategy promotes rapid integration and reduces merge conflicts by keeping all code changes in a single place. -Feature branches are avoided or kept extremely short-lived. - -Trunk-based development is suitable for high-paced environments where frequent releases and continuous integration are critical. - -== Choosing the Right Strategy - -Choosing the right branching strategy depends on several factors: -- Team size and structure. -- Frequency of releases. -- Stability and deployment requirements. -- Integration and testing workflows. - -By carefully considering these factors, teams can select a branching strategy that opt \ No newline at end of file +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/developer-guide/modules/concepts/pages/contribution-guidelines.adoc b/docs/developer-guide/modules/concepts/pages/contribution-guidelines.adoc index d24dac5..0c3e267 100644 --- a/docs/developer-guide/modules/concepts/pages/contribution-guidelines.adoc +++ b/docs/developer-guide/modules/concepts/pages/contribution-guidelines.adoc @@ -1,5 +1,9 @@ = Coding, commit and contribution guidelines +WARNING:: +This document is generated and a generic example of how a page with "real content" could look like. +It is not a real document and should not be used as a reference. + Effective coding, commit, and contribution guidelines are essential for maintaining a high-quality codebase and fostering productive collaboration within development teams. These guidelines serve as a blueprint for consistency, clarity, and efficiency in software development. diff --git a/docs/developer-guide/modules/concepts/pages/release-strategy.adoc b/docs/developer-guide/modules/concepts/pages/release-strategy.adoc index 20dd96c..2c85b3e 100644 --- a/docs/developer-guide/modules/concepts/pages/release-strategy.adoc +++ b/docs/developer-guide/modules/concepts/pages/release-strategy.adoc @@ -1,129 +1,11 @@ = Release strategy -A solid release strategy is essential for delivering software updates in an efficient, structured, and repeatable manner. -It encompasses planning, testing, deploying, and managing the software lifecycle to ensure high quality and minimal disruption. - -== Defining a Release Strategy - -A release strategy outlines the process and guidelines for carrying out software releases. -This includes planning the release cycle, ensuring code quality, coordinating with stakeholders, and managing post-release support. - -== Types of Releases - -Releases can vary in scope and purpose. -Understanding the different types is crucial for planning and execution. - -=== Major Releases - -- *Definition*: Major releases introduce significant changes, new features, and possibly breaking changes. -- *Impact*: These releases often require extensive development, testing, and documentation efforts. -- *Versioning*: Incremented in the "X.y.z" format (e.g., 2.0.0). - -=== Minor Releases - -- *Definition*: Minor releases add new functionality and improvements without breaking backward compatibility. -- *Impact*: They require moderate testing and documentation. -- *Versioning*: Incremented in the "x.Y.z" format (e.g., 1.1.0). - -=== Patch Releases - -- *Definition*: Patch releases focus on bug fixes, performance enhancements, and security patches. -- *Impact*: These are more frequent and usually require quick testing cycles. -- *Versioning*: Incremented in the "x.y.Z" format (e.g., 1.0.1). - -== Release Cycles - -Different release cycles cater to various development and business needs. - -=== Continuous Deployment - -- *Definition*: Automatically deploys code to production as soon as it passes all stages of the CI/CD pipeline. -- *Use Case*: Suitable for teams practicing DevOps and needing rapid, incremental updates. - -=== Continuous Delivery - -- *Definition*: The software is always in a deployable state; releases are made manually based on business decisions. -- *Use Case*: Ideal for teams balancing rapid updates with controlled release processes. - -=== Time-Based Releases - -- *Definition*: Releases are scheduled at regular intervals, such as monthly or quarterly. -- *Use Case*: Suitable for predictable planning and aligning with business cycles. - -=== Feature-Based Releases - -- *Definition*: Releases are based on the completion and readiness of specific features. -- *Use Case*: Ideal for projects driven by significant feature milestones. - -== Pre-Release Stages - -Ensuring stability and quality before reaching production is critical. - -=== Development Environment - -- *Purpose*: Where developers write and test their code. -- *Activities*: Code reviews, unit tests, and integration tests. - -=== Staging Environment - -- *Purpose*: Mimics the production environment for final testing. -- *Activities*: User Acceptance Testing (UAT), performance testing, and integration testing. - -== Deployment Strategies - -Choosing the right deployment strategy helps manage risks and ensures a smooth transition. - -=== Blue-Green Deployment - -- *Definition*: Maintain two identical environments (blue and green); one serves live traffic while the other is updated. -- *Use Case*: Minimizes downtime during deployment. - -=== Canary Releases - -- *Definition*: Gradually roll out changes to a small subset of users first. -- *Use Case*: Early detection of issues with minimal impact. - -=== Rolling Updates - -- *Definition*: Incrementally deploy updates to different parts of the infrastructure. -- *Use Case*: Helps in mitigating risks by updating in smaller batches. - -=== A/B Testing - -- *Definition*: Deploy different versions of the software to different user groups to test variations. -- *Use Case*: Useful for gathering user feedback and optimizing features. - -== Rollback Plan - -A rollback plan is essential to revert quickly in case of issues. - -- *Automated Rollback*: Scripts or tools to automate reverting changes. -- *Manual Rollback*: Detailed procedures for manually undoing changes. -- *Database Rollback*: Ensure database changes can be rolled back safely. - -== Communication - -Effective communication ensures all stakeholders are aware of the release status and any possible impacts. - -=== Release Notes - -- *Content*: Document key changes, new features, bug fixes, and known issues. -- *Distribution*: Share with stakeholders, users, and support teams. - -=== Stakeholder Meetings - -- *Purpose*: Keep stakeholders informed and aligned on release progress. -- *Frequency*: Regularly scheduled during the release cycle. - -== Post-Release Activities - -Post-release activities ensure the release is successful and any issues are promptly addressed. - -- *Monitoring*: Continuously monitor the release for performance and stability. -- *Support Plan*: Have a support plan to address user feedback and issues. -- *Incident Reports*: Document any issues and the steps taken to resolve them. - -== Conclusion - -A robust release strategy is vital for delivering high-quality software efficiently and predictably. -By carefully planning each stage, choosing appropriate deployment strategies, and maintaining clear communication, development teams can minimize risks, enhance product quality, and achieve business goals. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/developer-guide/modules/how-to/pages/debugging-guide.adoc b/docs/developer-guide/modules/how-to/pages/debugging-guide.adoc index 135d8ef..c0d605c 100644 --- a/docs/developer-guide/modules/how-to/pages/debugging-guide.adoc +++ b/docs/developer-guide/modules/how-to/pages/debugging-guide.adoc @@ -1 +1,11 @@ -= How to debug \ No newline at end of file += How to debug + +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/developer-guide/modules/how-to/pages/get-access.adoc b/docs/developer-guide/modules/how-to/pages/get-access.adoc index 49bcb77..fb2ba41 100644 --- a/docs/developer-guide/modules/how-to/pages/get-access.adoc +++ b/docs/developer-guide/modules/how-to/pages/get-access.adoc @@ -1 +1,11 @@ = How to get access rights + +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/developer-guide/modules/how-to/pages/local-setup.adoc b/docs/developer-guide/modules/how-to/pages/local-setup.adoc index 771fdbf..4a85231 100644 --- a/docs/developer-guide/modules/how-to/pages/local-setup.adoc +++ b/docs/developer-guide/modules/how-to/pages/local-setup.adoc @@ -1 +1,11 @@ = How to install a local setup (SEU/IDE/SEES) + +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/developer-guide/modules/how-to/pages/maintenance-routines.adoc b/docs/developer-guide/modules/how-to/pages/maintenance-routines.adoc index 0a1d76b..8b2c8ca 100644 --- a/docs/developer-guide/modules/how-to/pages/maintenance-routines.adoc +++ b/docs/developer-guide/modules/how-to/pages/maintenance-routines.adoc @@ -1 +1,11 @@ -= How to handle maintenance routines \ No newline at end of file += How to handle maintenance routines + +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/developer-guide/modules/how-to/pages/onboarding.adoc b/docs/developer-guide/modules/how-to/pages/onboarding.adoc index 94a503e..ab618e6 100644 --- a/docs/developer-guide/modules/how-to/pages/onboarding.adoc +++ b/docs/developer-guide/modules/how-to/pages/onboarding.adoc @@ -1 +1,11 @@ = How to onboard (I am new, what should I do) + +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/developer-guide/modules/how-to/pages/release.adoc b/docs/developer-guide/modules/how-to/pages/release.adoc index 6c66df4..06429a9 100644 --- a/docs/developer-guide/modules/how-to/pages/release.adoc +++ b/docs/developer-guide/modules/how-to/pages/release.adoc @@ -1 +1,11 @@ = How to release + +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/developer-guide/modules/how-to/pages/rollback.adoc b/docs/developer-guide/modules/how-to/pages/rollback.adoc index ffb4b28..fb79c8a 100644 --- a/docs/developer-guide/modules/how-to/pages/rollback.adoc +++ b/docs/developer-guide/modules/how-to/pages/rollback.adoc @@ -1 +1,11 @@ -= How to rollback \ No newline at end of file += How to rollback + +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/operations-guide/modules/how-to/pages/configure-access-rights.adoc b/docs/operations-guide/modules/how-to/pages/configure-access-rights.adoc index af3b00f..9f9fdc7 100644 --- a/docs/operations-guide/modules/how-to/pages/configure-access-rights.adoc +++ b/docs/operations-guide/modules/how-to/pages/configure-access-rights.adoc @@ -1,99 +1,11 @@ = Configure access rights -Managing access rights is crucial for ensuring the security and integrity of your systems and data. Proper configuration ensures that users have the appropriate level of access to perform their duties without compromising sensitive information. - -== Understanding Access Rights - -Access rights, also known as permissions, determine what operations users can perform within a system. These operations can include reading, writing, modifying, or deleting data. - -== Basic Concepts - -=== Users - -- *Users* are individual accounts that need access to the system. -Each user has unique credentials and associated permissions. - -=== Groups - -- *Groups* are collections of users that share common permissions. -Assigning permissions to groups simplifies access management. - -=== Roles - -- *Roles* are predefined sets of permissions tailored for specific job functions. -Users or groups are assigned roles to streamline access control. - -== Steps to Configure Access Rights - -Configure access rights by following these comprehensive steps to ensure a secure and functional environment. - -=== Step 1: Identify Requirements - -1. *Assess Needs*: Determine the access needs of different users and groups. -Identify who needs access to what resources and at what level. -2. *Compliance*: Ensure that your access control measures comply with relevant regulations and policies. - -=== Step 2: Define Users and Groups - -1. *Create Users*: Set up individual user accounts with unique credentials. -2. *Create Groups*: Organize users into groups based on similar access needs (e.g., Admins, Developers, Read-Only Users). - -[source,bash] -Example command to create a group -groupadd developers - -Example command to add a user to a group -usermod -aG developers john_doe - -=== Step 3: Assign Roles - -. *Create Roles*: Define roles that encapsulate various permission sets (e.g., Admin Role, Editor Role, Viewer Role). -. *Assign Roles*: Assign these roles to users or groups according to their access needs. - -[source,bash] -Example command to assign a role to a user -usermod -aG admin_role john_doe - -=== Step 4: Set Permissions - -. *File System Permissions*: Use file system commands to set read, write, and execute permissions on directories and files. -+ -[source,bash] -Example command to set file permissions -chmod 750 /path/to/directory chown john_doe:developers /path/to/directory -2. *Application Permissions*: Configure permissions within applications (e.g., database, web applications) through their specific interfaces or configuration files. - -=== Step 5: Implement Access Control Lists (ACLs) - -. *Create ACLs*: Use ACLs for fine-grained control over file and resource access. - -[source,bash] -Example command to set an ACL -setfacl -m u:john_doe:rwx /path/to/file - -=== Step 6: Review and Audit - -. *Regular Audits*: Conduct regular audits to review access rights and ensure that they conform to current needs and policies. -. *Access Logs*: Monitor access logs to detect any unauthorized access attempts. - -== Best Practices - -=== Principle of Least Privilege - -Grant users the minimum level of access required for their tasks to minimize security risks. - -=== Role-Based Access Control (RBAC) - -Implement RBAC to simplify access management by assigning roles to users instead of specific permissions. - -=== Regular Updates - -Regularly update and review user roles and permissions to ensure they align with current job functions and organizational changes. - -=== Documentation - -Maintain detailed documentation of the configured access rights, including users, groups, roles, and permissions. - -== Conclusion - -Configuring access rights is a critical aspect of system security and management. By following these steps and best practices, you can ensure that users have appropriate access while protecting sensitive information and maintaining compliance with regulations. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/operations-guide/modules/how-to/pages/emergency-playbook.adoc b/docs/operations-guide/modules/how-to/pages/emergency-playbook.adoc index d11d9e8..b343817 100644 --- a/docs/operations-guide/modules/how-to/pages/emergency-playbook.adoc +++ b/docs/operations-guide/modules/how-to/pages/emergency-playbook.adoc @@ -1,5 +1,9 @@ = Emergency playbook +WARNING:: +This document is generated and a generic example of how a page with "real content" could look like. +It is not a real document and should not be used as a reference. + An emergency playbook is a structured guide designed to help organizations efficiently manage and respond to critical incidents. This includes unexpected disruptions, security breaches, natural disasters, or other emergencies. A well-prepared playbook ensures a quick and effective response to mitigate damage and restore normal operations. == Introduction diff --git a/docs/operations-guide/modules/how-to/pages/recover-deleted-database.adoc b/docs/operations-guide/modules/how-to/pages/recover-deleted-database.adoc index 42834ad..9568cff 100644 --- a/docs/operations-guide/modules/how-to/pages/recover-deleted-database.adoc +++ b/docs/operations-guide/modules/how-to/pages/recover-deleted-database.adoc @@ -1,127 +1,11 @@ = Recover a deleted database -Restoring a deleted database can be quite complex, and the exact steps may vary depending on the specific database system you are using, such as MySQL, PostgreSQL, or SQL Server. -Below are some general guidelines for restoring a deleted database. - -== General Guidelines - -* Stop Using the Server: -** Immediately stop using the server to prevent new data from overwriting the deleted files. - -* Check Backups: -** The most reliable method is to restore from a backup. Check if you have recent backups and restore from there. - -* Recovery Tools: -** Use database-specific recovery tools provided by your database vendor or third-party recovery software. - -== Database-Specific Guidelines - -=== MySQL - -* From Backup: -** If you have a recent backup, use the `mysql` command-line tool to restore: -+ -[source,shell] ----- -mysql -u username -p database_name < backupfile.sql ----- - -* InnoDB Recovery: -** For InnoDB databases, you might need to use the `innodb_force_recovery` option in the MySQL configuration file. - -* Recovery Tools: -** Tools like `MySQL Enterprise Backup` or `Percona Data Recovery Toolkit` can be helpful. - -=== PostgreSQL - -* From Backup: -** Use the `pg_restore` command to restore from a `.dump` file: -+ -[source,shell] ----- -pg_restore -U username -d database_name backup_file.dump ----- - -* Point-in-Time Recovery: -** Use Point-in-Time Recovery (PITR) if you have Write-Ahead Logging (WAL) files. - -* Recovery Tools: -** Tools like `pgBackRest` or `Barman` can be helpful. - -=== SQL Server - -* From Backup: -** Use SQL Server Management Studio (SSMS) or a T-SQL script to restore from a backup: -+ -[source,sql] ----- -RESTORE DATABASE database_name -FROM DISK = 'backupfile.bak' -WITH RECOVERY; ----- - -* Point-in-Time Recovery: -** Use point-in-time restore to recover the database to a specific moment. - -* Recovery Tools: -** Tools like `Redgate` or `LiteSpeed` can be useful. - -== Steps for Restoring from Backup - -* Locate Backup: -** Find your most recent backup file. - -* Restore Process: -** Initiate the restore process using your database's specific commands or tools. - -* Verification: -** Verify the restored database to ensure data integrity. - -=== Example (MySQL) - -.Backup: -[source,shell] ----- -mysqldump -u root -p database_name > database_name_backup.sql ----- - -.Restoration: -[source,shell] ----- -mysql -u root -p database_name < database_name_backup.sql ----- - -=== Example (PostgreSQL) - -.Backup: -[source,shell] ----- -pg_dump -U username database_name > database_name_backup.sql ----- - -.Restoration: -[source,shell] ----- -psql -U username -d database_name -f database_name_backup.sql ----- - -=== Example (SQL Server) - -.Backup: -[source,sql] ----- -BACKUP DATABASE database_name -TO DISK = 'C:\backup\database_name.bak'; ----- - -.Restoration: -[source,sql] ----- -RESTORE DATABASE database_name -FROM DISK = 'C:\backup\database_name.bak' -WITH RECOVERY; ----- - -Always make sure to have regular backups and a well-documented disaster recovery plan in place to mitigate data loss in the future. -If the standard methods don't work, consulting with a database administrator or a professional data recovery service might be necessary. - +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/operations-guide/modules/how-to/pages/snooze-alerts.adoc b/docs/operations-guide/modules/how-to/pages/snooze-alerts.adoc index 507696f..ca833c9 100644 --- a/docs/operations-guide/modules/how-to/pages/snooze-alerts.adoc +++ b/docs/operations-guide/modules/how-to/pages/snooze-alerts.adoc @@ -1,126 +1,11 @@ = Snooze alerts -Snoozing alerts can help you manage notifications and warnings without immediately addressing them, allowing you to focus on other tasks. -The approach can vary depending on the specific system or application. -Below are some general guidelines and examples for snoozing alerts. - -== General Guidelines - -* Identify the Alert: -** Determine which alert you want to snooze. - -* Choose Snooze Duration: -** Decide how long you want to snooze the alert. - -* Confirm Snooze: -** Ensure that the alert has been successfully snoozed. - -== System-Specific Guidelines - -=== Windows Notifications - -* Open Action Center: -** Click on the Action Center icon in the taskbar. - -* Find the Alert: -** Locate the notification you want to snooze. - -* Click on the Snooze Icon: -** Click on the alarm clock icon or right-click the notification to choose a snooze duration. - -* Confirm: -** Make sure the notification is marked as snoozed. - -=== MacOS Notifications - -* Open Notification Center: -** Click on the Notification Center icon in the top-right corner of the screen. - -* Find the Alert: -** Locate the notification you want to snooze. - -* Click on Options: -** Click on the "Options" button or right-click to choose "Deliver Quietly" or another snooze option. - -* Confirm: -** Ensure the notification is updated to reflect the snooze. - -=== Mobile Devices (iOS or Android) - -* Pull Down Notification Shade: -** Swipe down from the top of the screen to open the notification shade. - -* Find the Alert: -** Locate the notification you want to snooze. - -* Swipe Left or Right: -** On iOS, swipe left and tap "Manage". On Android, swipe left or right slightly to reveal clock or snooze icons. - -* Select Snooze Duration: -** Choose the duration for which you want to snooze the alert. - -* Confirm: -** Ensure the notification is marked as snoozed. - -== Application-Specific Guidelines - -=== Google Calendar - -* Open Google Calendar: -** Navigate to https://calendar.google.com and log in. - -* Find the Alert: -** Locate the event with the notification you want to snooze. - -* Click on the Event: -** Click on the event to open its details. - -* Choose Snooze Option: -** Click on the snooze button or use the drop-down to select a snooze duration. - -* Confirm: -** Ensure the event notification is updated to reflect the snooze. - -=== Microsoft Outlook - -* Open Outlook: -** Launch Microsoft Outlook on your computer or go to the web app. - -* Find the Alert: -** Locate the reminder or notification you want to snooze. - -* Click on Snooze: -** Click the "Snooze" button in the reminder window and choose how long to snooze. - -* Confirm: -** Ensure the reminder is updated to reflect the snooze. - -=== Slack - -* Open Slack: -** Launch Slack on your computer or mobile device. - -* Find the Notification: -** Locate the channel or direct message with the notification you want to snooze. - -* Click on the Bell Icon: -** Click on the bell icon beside the channel name or in the top-right corner of the direct message. - -* Choose Snooze Duration: -** Select a duration to snooze notifications for that channel or DM. - -* Confirm: -** Ensure notifications are snoozed as per your selection. - -== Tips for Effective Use - -* Set Reasonable Durations: -** Choose snooze durations that give you enough time to focus but remind you to address the alert later. - -* Monitor Snoozed Alerts: -** Keep an eye on snoozed alerts to ensure important notifications are not missed. - -* Use Tools: -** Utilize built-in tools and features of your operating system or applications for efficient alert management. - -By following these guidelines, you can effectively manage and snooze alerts, allowing you to stay focused and organized. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/user-guide/modules/concepts/pages/index.adoc b/docs/user-guide/modules/concepts/pages/index.adoc index 4ae5a84..3ff4d73 100644 --- a/docs/user-guide/modules/concepts/pages/index.adoc +++ b/docs/user-guide/modules/concepts/pages/index.adoc @@ -1 +1,29 @@ = Concepts + +This section provides an overview of the concepts that are important to understand when working with the product. + +.What to write? +[example%collapsible] +==== +Intention:: +This section provides a high level overview of the concepts that are important to understand when working with the product. +This should help architects, developers, and administrators to understand the product better and make informed decisions. + +What to include:: +* High level overview of the concepts +* Links to detailed information + +External resources:: +* https://fastapi.tiangolo.com/deployment/concepts/[FastAPI -- Deployment Concepts] +* https://docs.microsoft.com/en-us/azure/architecture/guide/[Azure -- Architecture Center] +* https://www.dynaconf.com/merging/[Dynaconf -- Merging] + +.Hierarchical structure concept +[example] +===== +Hierarchical structure concept + +This section provides an overview of the hierarchical structure of the objects existing in the product. +Understanding the hierarchical structure is important to understand the relationships between the objects and how they interact with each other. +===== +==== \ No newline at end of file diff --git a/docs/user-guide/modules/concepts/pages/security.adoc b/docs/user-guide/modules/concepts/pages/security.adoc index 0a537d2..94f6eaf 100644 --- a/docs/user-guide/modules/concepts/pages/security.adoc +++ b/docs/user-guide/modules/concepts/pages/security.adoc @@ -1,5 +1,9 @@ = Security +WARNING:: +This document is generated and a generic example of how a page with "real content" could look like. +It is not a real document and should not be used as a reference. + Security is an essential aspect of modern digital life. This guide aims to provide you with the necessary information to understand and implement effective security measures. We'll cover fundamental concepts, best practices, and practical steps to enhance your security posture. diff --git a/docs/user-guide/modules/concepts/pages/shared-responsibility-model.adoc b/docs/user-guide/modules/concepts/pages/shared-responsibility-model.adoc index 408ea4d..90ecf13 100644 --- a/docs/user-guide/modules/concepts/pages/shared-responsibility-model.adoc +++ b/docs/user-guide/modules/concepts/pages/shared-responsibility-model.adoc @@ -1,5 +1,9 @@ = Shared responsibility model +WARNING:: +This document is generated and a generic example of how a page with "real content" could look like. +It is not a real document and should not be used as a reference. + In cloud computing, the concept of the shared responsibility model is crucial. It delineates the security obligations of cloud service providers and their customers. Understanding this model helps organizations effectively use cloud services while ensuring comprehensive security. diff --git a/docs/user-guide/modules/how-to/pages/authentication.adoc b/docs/user-guide/modules/how-to/pages/authentication.adoc index ce78b64..ae854c7 100644 --- a/docs/user-guide/modules/how-to/pages/authentication.adoc +++ b/docs/user-guide/modules/how-to/pages/authentication.adoc @@ -1,78 +1,11 @@ = How to authenticate -Authentication is the process of verifying the identity of a user, device, or system. -It is vital for ensuring that access to systems and data is granted only to authorized entities. -This guide outlines the various methods of authentication and provides steps to implement them effectively. - -== Types of Authentication - -There are several types of authentication methods: - -=== Password-Based Authentication - -Password-based authentication is one of the most common methods. -It involves the use of a secret key (password) that only the user knows. -To ensure strong password security, follow these best practices: - -* Use complex and unique passwords for each account. -* Change passwords regularly. -* Avoid using easily guessable passwords like 'password123'. - -=== Multi-Factor Authentication (MFA) - -Multi-factor authentication adds an additional layer of security by requiring two or more verification steps. -These steps include something you know (password), something you have (security token), and something you are (fingerprint). -Enabling MFA significantly reduces the risk of unauthorized access. - -=== Biometric Authentication - -Biometric authentication uses unique biological traits such as fingerprints, facial recognition, or iris scans. -Biometrics provide a high level of security since these traits are difficult to duplicate or forge. - -=== Token-Based Authentication - -Token-based authentication involves issuing a security token to the user upon successful login. -This token is then used to access services without needing to re-enter credentials. -Common types of tokens include hardware tokens, software tokens, and one-time password (OTP) tokens. - -=== Certificate-Based Authentication - -Certificate-based authentication employs digital certificates to validate identities. -Certificates use public key infrastructure (PKI) for encryption and decryption, ensuring secure communication. - -== Steps to Authenticate - -The steps for authenticating vary based on the method used. -Here are some general steps for password-based authentication and MFA. - -=== Password-Based Authentication - -. Navigate to the login page of the application or service. -. Enter your username or email address. -. Enter your password in the designated field. -. Click the 'Login' or 'Submit' button to access the system. - -=== Multi-Factor Authentication (MFA) - -. Follow the steps for password-based authentication to log in with your username and password. -. Upon successful password entry, you will be prompted for a second form of authentication. -. Depending on the MFA method, perform one of the following: -** Enter the code sent to your registered mobile device. -** Approve the login request on your authentication app. -** Swipe your fingerprint on the fingerprint reader. -. Once the second factor is verified, you will be granted access. - -== Troubleshooting Authentication Issues - -If you encounter issues during authentication, consider these troubleshooting steps: - -* Ensure you are entering the correct username and password. -* Check the internet connection as some authentication methods require network access. -* Verify that your device's time and date settings are accurate. -* Contact your system administrator or support team for further assistance. - -== Conclusion - -Authentication is a crucial component of security, safeguarding systems and data from unauthorized access. -By understanding and implementing various authentication methods, you can enhance the security of your digital assets. -Consistently follow best practices to maintain strong authentication protocols and protect your information. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/user-guide/modules/how-to/pages/backup.adoc b/docs/user-guide/modules/how-to/pages/backup.adoc index 3ed26f0..cf03b71 100644 --- a/docs/user-guide/modules/how-to/pages/backup.adoc +++ b/docs/user-guide/modules/how-to/pages/backup.adoc @@ -1,3 +1,11 @@ = How to back up -Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/user-guide/modules/how-to/pages/cli.adoc b/docs/user-guide/modules/how-to/pages/cli.adoc index cfcd10c..8a6c1fa 100644 --- a/docs/user-guide/modules/how-to/pages/cli.adoc +++ b/docs/user-guide/modules/how-to/pages/cli.adoc @@ -1,3 +1,11 @@ = How to use the CLI -Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/user-guide/modules/how-to/pages/configure.adoc b/docs/user-guide/modules/how-to/pages/configure.adoc index 5664673..f96734e 100644 --- a/docs/user-guide/modules/how-to/pages/configure.adoc +++ b/docs/user-guide/modules/how-to/pages/configure.adoc @@ -1,3 +1,11 @@ = How to configure -Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/user-guide/modules/how-to/pages/index.adoc b/docs/user-guide/modules/how-to/pages/index.adoc index 6439f72..df8b783 100644 --- a/docs/user-guide/modules/how-to/pages/index.adoc +++ b/docs/user-guide/modules/how-to/pages/index.adoc @@ -1 +1,61 @@ -= How to \ No newline at end of file += How-to + +This section provides how-tos for common tasks. +Users get guidance on how to perform specific tasks for real-world scenarios. + +.What to write? +[example%collapsible] +==== +Intention:: +Intention of this section is to guides for users of the product on how to perform specific tasks. +This should help improve the user experience and reduce the number of support requests. +Be concise and clear in your instructions. +You can assume some level of familiarity with the product, but don't assume that the user is an expert. +Add references to "reference" and "concepts" sections where appropriate. +See +https://diataxis.fr/how-to-guides/[How-to guides in diataxis] +for more information. + +What to include:: +* Set up the project +* Typical use cases +** Example: Backup +** Example: Restore +** Example: Upgrade +* Configuration +* User management +* Troubleshooting + +External resources:: +* https://taskfile.dev/usage/[Taskfile] +* https://docs.spring.io/spring-boot/how-to/logging.html[Spring Boot Logging] +* https://go.dev/doc/modules/publishing[Publish Go Modules] +* https://www.gnu.org/software/make/manual/make.html[GNU Make] + +.Dependency maintenance routine guide +[example] +===== +User management guide + +This section provides guidance on how to manage users in the system. +Adding, removing, and updating users is a common task for administrators. +This guide provides step-by-step instructions. + +. *Open user management site* +* Open the user management site by navigating to the following URL: `https://example.com/user-management`. + +. *Create user* +* Click the "Create User" button. +* Fill in the user details. +* Click "Save". + +. *Update user* +* Click the "Edit" button next to the user you want to update. +* Update the user details. +* Click "Save". + +. *Delete user* +* Click the "Delete" button next to the user you want to delete. +* Confirm the deletion. +===== +==== diff --git a/docs/user-guide/modules/how-to/pages/migration-guide.adoc b/docs/user-guide/modules/how-to/pages/migration-guide.adoc index e0b73ca..faa70f0 100644 --- a/docs/user-guide/modules/how-to/pages/migration-guide.adoc +++ b/docs/user-guide/modules/how-to/pages/migration-guide.adoc @@ -1,3 +1,11 @@ = How to migrate (Migration Guide) -Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/user-guide/modules/how-to/pages/setup-tools.adoc b/docs/user-guide/modules/how-to/pages/setup-tools.adoc index da1e667..7ff4398 100644 --- a/docs/user-guide/modules/how-to/pages/setup-tools.adoc +++ b/docs/user-guide/modules/how-to/pages/setup-tools.adoc @@ -1,3 +1,11 @@ = How to set up tools -Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/user-guide/modules/reference/pages/core-features.adoc b/docs/user-guide/modules/reference/pages/core-features.adoc index 30df59d..0d1d024 100644 --- a/docs/user-guide/modules/reference/pages/core-features.adoc +++ b/docs/user-guide/modules/reference/pages/core-features.adoc @@ -1,3 +1,11 @@ = Core features -Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/user-guide/modules/reference/pages/index.adoc b/docs/user-guide/modules/reference/pages/index.adoc index b0df807..43c476b 100644 --- a/docs/user-guide/modules/reference/pages/index.adoc +++ b/docs/user-guide/modules/reference/pages/index.adoc @@ -1 +1,52 @@ = Reference + +This section provides detailed information about the product. +Information found here is intended for users that have very good knowledge about the product and want to solve very specific tasks. + +.What to write? +[example%collapsible] +==== +Intention:: +Intention of this section is to provide detailed information about the product. +It should help power users to solve very specific tasks. +See +https://diataxis.fr/reference/[Reference in diagtaxis] +for more information. + +What to include:: +* Detailed information about the product +* API documentation +* CLI documentation +* Configuration options + +External resources:: +* https://taskfile.dev/reference/cli[Taskfile -- CLI reference] +* https://fastapi.tiangolo.com/reference/status/[FastAPI -- Status codes] +* https://docs.docker.com/reference/[Docker -- Reference] +* https://docs.spring.io/spring-boot/reference/web/graceful-shutdown.html[Spring Boot -- Graceful shutdown] + +.Product API reference +[example] +===== +Product API reference + +This section provides detailed information about the product's API. + +`GET /items`:: +Returns a list of all available resources. + +`POST /items`:: +Creates a new resource. +The JSON body should contain the resource data: +[source,json] +---- +{ + "name": "string", + "description": "string" +} +---- + +`GET /items/{id}`:: +Returns a specific resource. +===== +==== \ No newline at end of file diff --git a/docs/user-guide/modules/reference/pages/java-sdk.adoc b/docs/user-guide/modules/reference/pages/java-sdk.adoc index df263a8..1a17056 100644 --- a/docs/user-guide/modules/reference/pages/java-sdk.adoc +++ b/docs/user-guide/modules/reference/pages/java-sdk.adoc @@ -1,3 +1,11 @@ = Java SDK -Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/user-guide/modules/reference/pages/openapi.adoc b/docs/user-guide/modules/reference/pages/openapi.adoc index a4a8f4e..f60ef24 100644 --- a/docs/user-guide/modules/reference/pages/openapi.adoc +++ b/docs/user-guide/modules/reference/pages/openapi.adoc @@ -1,3 +1,11 @@ = OpenAPI -Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/user-guide/modules/reference/pages/releases.adoc b/docs/user-guide/modules/reference/pages/releases.adoc index 21d8aae..857dec4 100644 --- a/docs/user-guide/modules/reference/pages/releases.adoc +++ b/docs/user-guide/modules/reference/pages/releases.adoc @@ -1,3 +1,11 @@ = Release history -Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +At vero eos et accusam et justo duo dolores et ea rebum. +Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. diff --git a/docs/user-guide/modules/tutorial/pages/deploy-first-app.adoc b/docs/user-guide/modules/tutorial/pages/deploy-first-app.adoc index ab66621..a8a169d 100644 --- a/docs/user-guide/modules/tutorial/pages/deploy-first-app.adoc +++ b/docs/user-guide/modules/tutorial/pages/deploy-first-app.adoc @@ -1,5 +1,9 @@ = Deploy my first app +WARNING:: +This document is generated and a generic example of how a page with "real content" could look like. +It is not a real document and should not be used as a reference. + Deploying an application involves making it available to users by hosting it on a server or cloud platform. This guide will walk you through the steps of deploying your first app, from preparation to final deployment. By following these instructions, you can ensure a smooth and successful deployment process. diff --git a/docs/user-guide/modules/tutorial/pages/index.adoc b/docs/user-guide/modules/tutorial/pages/index.adoc index be0843c..adf7d0e 100644 --- a/docs/user-guide/modules/tutorial/pages/index.adoc +++ b/docs/user-guide/modules/tutorial/pages/index.adoc @@ -1 +1,103 @@ = Tutorials + +This section provides tutorials that help the user to understand the basic concepts of the project. + +.What to write? +[example%collapsible] +==== +Intention:: +The text guides the user, gives tasks, shows what the solution should look like, and explains the solution. +Examples are simplified to make the learning process easier. +Solutions provided do not need to be production-ready code. +Explain in small steps what the user will do and how that works. +See +https://diataxis.fr/tutorials/[Tutorials in diagtaxis] +for more information. + +What to include:: +* Getting started +* Basic concepts +* Deploy my first X +* Add Y to my X + +External resources:: +* https://spring.io/guides/gs/spring-boot[Spring Boot -- Getting Started Guide] +* https://go.dev/doc/tutorial/[Go -- Tutorials] +* https://fastapi.tiangolo.com/tutorial/[FastAPI -- Tutorial] +* https://taskfile.dev/usage/#getting-started[Taskfile -- Getting Started Guide] + +.Deploy my first FastAPI application on Heroku +[example] +===== +Deploy my first FastAPI application on Heroku + +This section will guide you through deploying your first FastAPI application on Heroku. +Required tools are Heroku CLI, Git, and a Heroku account. +You can set up a free account at +https://signup.heroku.com[Heroku] +if you don't have one. + +*Create the repository* + +Go to your local folder of choice and create a new git repository. + +[source,shell] +---- +mkdir ~/workspace <1> +cd ~/workspace <2> +git init my-fastapi-app <3> +cd my-fastapi-app <4> +git commit --allow-empty -m "Initial commit" <5> +---- + +<1> Create a new folder to store your projects under your home directory +<2> Change to the newly created folder +<3> Initialize a new git repository with the name `my-fastapi-app` +<4> Change to the newly created folder +<5> Create an initial commit, see this +https://www.garfieldtech.com/blog/git-empty-commit[blog article]. + +You now have a new git repository you can work with. + +*Initialize FastAPI project* + +We now need to create a FastAPI project. +To do this, create new file `main.py` in the root of the repository. +Add the following code to the file: + +[source,python] +---- +from typing import Union <1> +from fastapi import FastAPI + +app = FastAPI() <2> + + +@app.get("/") <3> +def read_root(): + return {"Hello": "World"} <4> + + +@app.get("/items/{item_id}") <5> +def read_item(item_id: int, q: Union[str, None] = None): + return {"item_id": item_id, "q": q} +---- + +<1> Import the required modules +<2> Create a new FastAPI application instance +<3> Define a new route for the root path +<4> Return a JSON response +<5> Define a new route for the `/items/{item_id}` path + +You now have a simple FastAPI application that has two routes. +A route on the root path `/` that returns a static JSON response and a route on `/items/{item_id}` that returns the item ID and a query parameter `q`. + +*Commit and push changes* + +... + +*Deploy app to Heroku* + +... +===== +====