Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use plain language #138

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Use plain language #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f85d642
Simplify language
abitrolly Sep 14, 2024
afdd3d4
Explain what a devfile is in a cleaner way
abitrolly Sep 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apps/landing-page/pages/_app.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ function collectHeadings(
}

const websiteName = 'Devfile.io';
const websiteDescription = 'An open standard defining containerized development environments.';
const websiteDescription = 'An open standard for containerized development environments.';

function LandingPage({ Component, pageProps }: AppProps): JSX.Element {
const { markdoc } = pageProps as MarkdocNextJsPageProps;
Expand Down
2 changes: 1 addition & 1 deletion libs/core/src/components/hero/hero.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ export function Hero(): JSX.Element {
Simplify and accelerate your workflow.
</p>
<p className="mt-3 text-2xl tracking-tight text-slate-400">
An open standard defining containerized development environments.
An open standard for containerized development environments.
</p>
<div className="mt-8 flex gap-4 md:justify-center lg:justify-start">
<Button
Expand Down
18 changes: 8 additions & 10 deletions libs/docs/src/docs/no-version/what-is-a-devfile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,14 @@ title: What is a devfile
description: What is a devfile
---

You can use devfiles to automate and simplify your development process
by adopting the existing devfiles that are available in the [public community registry](https://registry.devfile.io/viewer)
or by authoring your own devfiles to record custom instructions to
configure and run your build environment as a YAML-formatted text file.
You can make these devfiles available in the supporting build tools and
IDEs that can automatically process the devfile instructions to configure
and build a running application from a development project.

Using the recommended best practices from the devfile, the tools and IDE
can:
`devfile.yaml` describes how to configure and run build environment for
your project in a development container. You can create devfile from scratch or
adopt existing from [public community registry](https://registry.devfile.io/viewer).

Certain build tools and IDEs can automatically process the devfile
to configure and build a running application from a development project.

Using devfile, the tools and IDE can:

- Take in the repository hosting your application source code.

Expand Down