Skip to content

Fixes redirect and updates readme #22

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

Merged
merged 1 commit into from
Aug 22, 2022
Merged

Fixes redirect and updates readme #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions .eslintignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
**/dist
1 change: 1 addition & 0 deletions .prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
**/*.yaml
**/generated/
**/snippet.*
**/dist
160 changes: 6 additions & 154 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,176 +4,28 @@ Monorepo for web related devfile projects

## Getting started

This project uses [`yarn`](https://classic.yarnpkg.com/lang/en/docs/install).

It is highly recommended to download the [Nx Console](https://nx.dev/using-nx/console#download) extension for your IDE if available.

### Workspace commands
## Workspace commands

Run `yarn install` to download dependencies.

#### Specific project commands
### Specific project commands

- `yarn nx serve <project-name> --configuration=<development | production>`: serves the project's application
- `yarn nx build <project-name> --configuration=<development | production>`: builds the project's application
- `yarn nx run <project-name>:export`: exports the project's application to be static
- `yarn nx test <project-name>`: tests the project's application
- `yarn nx lint <project-name>`: lints the project's application

#### Nonspecific project commands
### Nonspecific project commands

- `yarn create:component <name>`: creates a React component
- `yarn create:hook <name>`: creates a React hook
- `yarn create:function <name>`: creates a function

## landing-page

Landing Page project for [devfile.io](https://devfile.io/).

### Configuring navigation

- Header

Header navigation can be configured on [`navigation.ts`](https://github.com/devfile/devfile-web/blob/main/apps/landing-page/navigation.ts).

```ts
export const headerNavigation: HeaderNavigation = [
...
];
```

Each element in `headerNavigation` is as follows:

```ts
[
{
name: 'Example', // the name of the link
href: 'https://example.com', // the URI of the link
image: ExampleIcon, // Optional: the image of the link
}
]
```

- Footer

Footer navigation can be configured on [`navigation.ts`](https://github.com/devfile/devfile-web/blob/main/apps/landing-page/navigation.ts).

```ts
export const footerNavigation: FooterNavigation = {
contributors: [
...
],
links: [
...
],
social: [
...
],
};
```

- `contributors`: contributors the the devfile project in alphabetical order
- `links`: miscellaneous links related to the devfile project
- `social`: social links for the devfile project

Each element in `contributors`, `links`, and `social` is as follows:

```ts
[
{
name: 'Example', // the name of the link
href: 'https://example.com', // the URI of the link
image: ExampleIcon, // Optional: the image of the link
},
...
]
```

- Sidebar

Sidebar navigation can be configured under [`./docs-navigation`](https://github.com/devfile/devfile-web/blob/main/apps/landing-page/public/docs-navigation).

Each file under `/docs-navigation` corresponds to a version except `no-version.yaml` which allows uniform navigation pages between all versions.

Whenever you update the sidebar navigation you **MUST** restart the server.

Each sidebar section requires a `title` and `links`. Each element in `links` requires a `title` and `href`. Currently, sidebar navigation is only supported one layer deep.

```yaml
- title: Example section 1
links:
- title: Element 1
href: /element1
- title: Element 2
href: /element2
- title: Example section 2
links:
- title: Element 3
href: /element3
- title: Element 3
href: /element4
```

### Updating documentation

To update or add documentation, edit or create a markdown file under [`./docs`](https://github.com/devfile/devfile-web/tree/main/apps/landing-page/pages/docs). The markdown is converted to html pages automatically by the [markdoc](https://markdoc.io/) Next.js addon. Instead of using `.mdx`, markdoc extends markdown by enclosing snippets in curly brackets.

- [Built-in tags](https://markdoc.io/docs/tags#built-in-tags)

- Custom tags

Custom tags can be found under [`./tags.tsx`](https://github.com/devfile/devfile-web/blob/main/apps/landing-page/markdoc/tags.tsx)

- `fences`

Curly brackets after specifying the code language is optional.

````md
```yaml {% title="Optional: Example" filename="Optional: devfile.yaml" %}
schemaVersion: 2.2.0
metadata:
name: mydevfile
components:
- name: mydevfile
volume:
size: 200G
```
````

- `callout`

The children for `callout` can be any valid markdown or snippet.

```md
{% callout title="Note!" %}
- All location references to `starterProjects` will change to local
paths relative to the stacks directory.

- Stack component image references will change to use the offline
accessible image repository.
{% /callout %}
```

- `figure`

```md
{% figure src="./example" alt="Example" caption="This is an example caption" /%}
```

- `quick-link` and `quick-links`

```md
{% quick-links %}

{% quick-link title="Installation" icon="installation" href="/" description="Step-by-step guides to setting up your system and installing the library." /%}

{% quick-link title="Architecture guide" icon="presets" href="/" description="Learn how the internals work and contribute." /%}

{% quick-link title="Plugins" icon="plugins" href="/" description="Extend the library with third-party plugins or write your own." /%}

{% quick-link title="API reference" icon="theming" href="/" description="Learn to easily customize and modify your app's visual design to fit your brand." /%}

{% /quick-links %}
```

After you update any documentation, update the navigation if you added a new page or changed a file name.

### Releasing a new version
[Landing Page README](https://github.com/devfile/devfile-web/tree/main/apps/landing-page)
6 changes: 4 additions & 2 deletions apps/landing-page/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
**/docs
**/devfile-schemas
pages/docs/**
!pages/docs/index.tsx

public/devfile-schemas
Loading