Skip to content
This repository was archived by the owner on Nov 5, 2024. It is now read-only.

Commit cf9b7e7

Browse files
jc-bergergtrivedi88
authored andcommitted
Merge pull request #107 from gtrivedi88/HACDOCS-454
Updated the how-to-guides-landing page
2 parents 10321ec + add5321 commit cf9b7e7

File tree

10 files changed

+110
-107
lines changed

10 files changed

+110
-107
lines changed

docs/modules/ROOT/nav-concepts.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
* xref:concepts/index.adoc[Concepts]
2-
** xref:concepts/release-services/con_release-services-overview.adoc[Release services]
3-
** xref:concepts/enterprise-contract/con_enterprise-contract-overview.adoc[Enterprise contract]
1+
* Conceptss
42
** xref:concepts/RenovateBot/index.adoc[RenovateBot]
53
** xref:concepts/java-build-service/java-build-service.adoc[Java build service]
64
** xref:concepts/java-build-service/java-build-service-components.adoc[Java build service components]

docs/modules/ROOT/nav-getting-started.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
* xref:getting-started/why-product-name.adoc[Why {ProductName}]
1+
* xref:index.adoc[Why {ProductName}]
22
* xref:getting-started/get-started.adoc[Get started]
33
** xref:getting-started/getting_started_in_cli.adoc[Getting started in the CLI]
44

docs/modules/ROOT/nav-how-to-guides.adoc

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,15 @@
1-
* How-to guides
1+
* xref:how-to-guides/how-to-guide-landing-page.adoc[How-to guides]
22
** xref:how-to-guides/proc_upgrade_build_pipeline.adoc[Upgrading the build pipeline]
3+
** Testing your application
4+
*** xref:how-to-guides/testing_applications/con_test-overview.adoc[Overview of {ProductName} Test components]
5+
*** xref:how-to-guides/testing_applications/surface-level_tests.adoc[Surface-level test]
36
** Secure your supply chain
47
*** xref:how-to-guides/Secure-your-supply-chain/proc_inspect_sbom.adoc[Inspecting SBOMs]
5-
**** xref:how-to-guides/Secure-your-supply-chain/proc_inspect_sbom.adoc#_downloading_an_sbom_in_the_web_ui[In the web UI]
6-
**** xref:how-to-guides/Secure-your-supply-chain/proc_inspect_sbom.adoc#_downloading_an_sbom_in_the_cli[In the CLI]
78
*** xref:how-to-guides/Secure-your-supply-chain/proc_java_dependencies.adoc[Configuring dependencies rebuild for Java apps in the CLI]
8-
** xref:how-to-guides/proc_creating_your_own_environment.adoc[Web UI: Creating your own environment]
9-
** xref:how-to-guides/creating_a_custom_application_test_with_test_pipelines.adoc[CLI: Creating a custom application test with test pipelines]
10-
** xref:how-to-guides/delete_application.adoc[CLI: Deleting an application].
11-
** xref:how-to-guides/delete_application.adoc[Web UI: Deleting an application].
12-
** xref:how-to-guides/proc_managing-compliance-with-the-enterprise-contract.adoc[Web UI: Managing compliance with the Enterprise Contract]
9+
** xref:how-to-guides/proc_creating_your_own_environment.adoc[Creating your own environment]
10+
** xref:how-to-guides/creating_a_custom_application_test_with_test_pipelines.adoc[Creating a custom application test with test pipelines]
11+
** xref:how-to-guides/proc_managing-compliance-with-the-enterprise-contract.adoc[Managing compliance with the Enterprise Contract]
1312
** xref:how-to-guides/proc_delete_application.adoc[Deleting an application].
14-
*** xref:how-to-guides/proc_delete_application.adoc#deleting-an-application-in-the-ui[In the web UI].
15-
*** xref:how-to-guides/proc_delete_application.adoc#deleting-an-application-in-the-cli[Using CLI].
1613
1714
1815
////

docs/modules/ROOT/nav-support.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
* xref:support/index.adoc[Support]
1+
* xref:support/support.adoc[Support]

docs/modules/ROOT/pages/getting-started/why-product-name.adoc

Lines changed: 0 additions & 57 deletions
This file was deleted.
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
== How-to guides
2+
Guides to help you complete a specific goal.
3+
4+
.xref:how-to-guides/proc_upgrade_build_pipeline.adoc[**Upgrading the build pipeline**]
5+
6+
Provides procedures for upgrading the build pipeline.
7+
8+
.xref:how-to-guides/Secure-your-supply-chain/proc_inspect_sbom.adoc[**Inspecting Software bill of materials (SBOMS)**]
9+
10+
Provides procedures on downloading SBOMS through the UI and using the CLI.
11+
12+
.xref:how-to-guides/Secure-your-supply-chain/proc_java_dependencies.adoc[**Configuring dependencies rebuild for Java applications**]
13+
14+
Provides procedures on configuring dependencies rebuild for Java applications
15+
16+
17+
.xref:how-to-guides/proc_creating_your_own_environment.adoc[**Creating your own environment**]
18+
19+
Provides procedures on creating your own environment.
20+
21+
.xref:how-to-guides/creating_a_custom_application_test_with_test_pipelines.adoc[**Creating a Custom Application Test with Test Pipelines**]
22+
23+
Provides procedures on how integration services use Tekton test pipelines and test scenarios.
24+
25+
.xref:how-to-guides/testing_applications/con_test-overview.adoc[**Testing applications**]
26+
27+
Provides information on {ProductName} test components and surface-level tests
28+
29+
.xref:how-to-guides/proc_managing-compliance-with-the-enterprise-contract.adoc[**Managing compliance with the Enterprise Contract**]
30+
31+
Provides procedures on managing compliance with the Enterprise Contract through UI and using CLI.
32+
33+
.xref:how-to-guides/proc_delete_application.adoc[**Deleting an application**]
34+
35+
Provides procedures on deleting an application through UI and using the CLI.
36+
37+

docs/modules/ROOT/pages/how-to-guides/index.adoc

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/modules/ROOT/pages/index.adoc

Lines changed: 40 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,57 @@
1-
= {ProductName}
2-
:toc: left
3-
:toclevels: 1
4-
:icons: font
5-
:numbered:
6-
:source-highlighter: highlightjs
1+
= Why {ProductName}?
72

8-
Welcome to the {ProductName} documentation!
3+
Developing an app is a long, costly process. Multiple teams, computing power, and a whole lot of time make the endeavor of launching an app _expensive_.
94

10-
== Why use {ProductName}?
5+
Enter {ProductName} – your one stop shop for building, testing, and deploying source code with secure CI/CD. Simply input the URL of your repository into our service, and we get to work building a pipeline, generating a snapshot, testing your code, and ultimately deploying your application to the hybrid cloud. Quickly get your app out to the world and then immediately see the value that it creates.
116

12-
You can use {ProductName} to enable continuous integration and continuous development (CI/CD) for your applications in a matter of minutes. You can also use {ProductName} to secure your software supply chain. With {ProductName}, you can reach link:https://slsa.dev/spec/v0.1/levels#summary-of-levels[SLSA level 3] security standards. And you can customize how {ProductName} builds, tests, and deploys containerized applications.
7+
*Give us a few clicks, and we’ll get you started in a few minutes.*
138

14-
== Important notices about the privacy of your data
9+
_We’re secure_: We provide support for https://slsa.dev/spec/v0.1/levels#summary-of-levels[SLSA Level 3] compliance to help you spot critical vulnerabilities. You can rest assured that our strong protections against tampering and threats can help keep you and your applications safe.
1510

16-
=== Publication notification for GitHub and Quay
11+
_We’re fast_: We help you import, containerize, and deploy your applications in minutes.
1712

18-
As a user, you have the right to understand where and how you enter personal and sensitive data, and when your data gets published to GitHub or Quay.
13+
Let’s get to work and give you back the time, effort, and money that your developers traditionally spent on manual processes.
1914

20-
=== Data in Quay is public
15+
== Key features
16+
Want to learn more? You can benefit from all of the following features with {ProductName}:
2117

22-
If you use a public GitHub repository as a component’s source, {ProductName} publishes the container image it builds to a public Quay repository.
18+
* Build your Java, Python, Node, or Go-based application into a container image.
19+
* Apply the appropriate attestations and cryptographic signatures and provenance by using Tekton chains.
20+
* Automatically deploy your container image to a provided development environment.
21+
* Verify that your container image meets SLSA guidelines by using our enterprise contract with 41+ rules.
22+
* Catch critical vulnerabilities quickly with each pull request.
23+
* Continuously build, test, and roll out your applications with a simple `git push` or acceptance of a pull request.
24+
* Take advantage of GitOps-based continuous deployment with an embedded ArgoCD to your Kubernetes.
25+
* And much more!
2326

24-
*Note:* There is no functionality to use a private Quay repository. The artifacts {ProductName} builds are public and visible to anyone who is viewing the Quay repository.
27+
== Use cases
28+
You can create applications with any of the following languages and frameworks:
2529

26-
=== Data in GitHub repositories is public
30+
* Java
31+
* Spring Boot
32+
* Quarkus
33+
* Node.js
34+
* Python
35+
* Go
2736

28-
When you create an application, {ProductName} stores the link to your GitHub repository, branch, and folder in a GitOps repository managed by {ProductName}. {ProductName} uses that link when it pulls code from your GitHub repository. If you use a personal repo or personal fork from a public project, these Github repository URLs contain your personal Git username.
37+
We use our Dockerfiles and Devfiles to containerize your application.
2938

30-
*Note:* There is no functionality to store the application configuration in a private GitOps repository. The artifacts created by {ProductName} are public and visible to anyone who is viewing the GitOps repository.
39+
== How does it work?
3140

32-
=== Data in deployment variables is public
41+
Under the hood, {ProductName} is largely based on OpenShift, Tekton, and ArgoCD. To get started, you don’t need to know anything about those technologies, but we know you might be curious!
3342

34-
Developers often use deployment variables, also called environment variables, to store runtime configurations. These variables could contain sensitive data, such as database connections or credential information.
43+
=== Customized Tekton build pipeline
44+
{ProductName} enables you to have a Tekton pipeline stored in your own repo. We provide features to help you keep that pipeline up to date and in compliance with your release standards.
3545

36-
*Note:* There is no functionality to secure sensitive data within a deployment variable. {ProductName} stores deployment variables in a public GitOps repository. Therefore, do not enter any sensitive data in deployment variables at all.
46+
=== View your triggered builds
47+
We automatically start a build by using the pipeline definition in your pull request (PR). You can set up your PRs to auto-merge after successful PR tests.
3748

38-
== Using these documents
39-
To learn more and to get started with {ProductName}, see the following sections:
49+
We post PR test feedback on GitHub by using the `checks` API. In this way, your application code and your build pipeline code can be properly tested and automatically merged. Builds that are triggered by a PR are not deployed to your development environment, so you must merge them first.
4050

41-
xref:getting-started/get-started.adoc[Getting started]:: Get started with {ProductName}.
42-
[]
43-
xref:how-to-guides/index.adoc[*How-to guides*]:: Put {ProductName} to work for you.
44-
[]
45-
xref:concepts/testing_applications/con_test-overview.adoc[*Concepts*]:: Learn about technical and conceptual information.
46-
[]
47-
xref:glossary/index.adoc[*Glossary*]:: View a list of relevant terms and their definitions.
48-
[]
49-
xref:contribute/index.adoc[*Contribute to documentation*]:: View guidelines for contributing.
50-
[]
51-
xref:support/index.adoc[*Support*]:: Join us on Slack, email us, or raise an issue.
51+
=== Merge and retest your pull requests
52+
After you merge the PR, the commit activity shows that the merged commit is being built. If successful, we trigger any integration tests that you defined and then move to deployment.
53+
54+
With {ProductName}, it’s easy to automate the application creation process from commit to production deployment.
55+
56+
== What’s next
57+
To learn how to create an app with a sample, go to xref:getting-started/get-started.adoc[Getting started].
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
= Important notices about the privacy of your data
2+
3+
== Publication notification for GitHub and Quay
4+
5+
As a user, you have the right to understand where and how you enter personal and sensitive data, and when your data gets published to GitHub or Quay.
6+
7+
== Data in Quay is public
8+
9+
If you use a public GitHub repository as a component’s source, {ProductName} publishes the container image it builds to a public Quay repository.
10+
11+
*Note:* There is no functionality to use a private Quay repository. The artifacts {ProductName} builds are public and visible to anyone who is viewing the Quay repository.
12+
13+
== Data in GitHub repositories is public
14+
15+
When you create an application, {ProductName} stores the link to your GitHub repository, branch, and folder in a GitOps repository managed by {ProductName}. {ProductName} uses that link when it pulls code from your GitHub repository. If you use a personal repo or personal fork from a public project, these Github repository URLs contain your personal Git username.
16+
17+
*Note:* There is no functionality to store the application configuration in a private GitOps repository. The artifacts created by {ProductName} are public and visible to anyone who is viewing the GitOps repository.
18+
19+
== Data in deployment variables is public
20+
21+
Developers often use deployment variables, also called environment variables, to store runtime configurations. These variables could contain sensitive data, such as database connections or credential information.
22+
23+
*Note:* There is no functionality to secure sensitive data within a deployment variable. {ProductName} stores deployment variables in a public GitOps repository. Therefore, do not enter any sensitive data in deployment variables at all.
File renamed without changes.

0 commit comments

Comments
 (0)