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.

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

Reorganize sidebar before starting to write solution level docs #91

Merged
merged 16 commits into from
Dec 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions docs/components/elemental.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Elemental
---

https://elemental.docs.rancher.com
5 changes: 5 additions & 0 deletions docs/components/fleet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Fleet
---

https://fleet.rancher.io
5 changes: 5 additions & 0 deletions docs/components/longhorn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Longhorn
---

https://longhorn.io/docs/
3 changes: 3 additions & 0 deletions docs/components/metal3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Metal3
---
agracey marked this conversation as resolved.
Show resolved Hide resolved
3 changes: 1 addition & 2 deletions docs/quickstart/metallb.md → docs/components/metallb.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
sidebar_position: 4
title: MetalLB on K3s
title: MetalLB
---

# Intro
Expand Down
5 changes: 5 additions & 0 deletions docs/components/neuvector.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Neuvector
---

https://open-docs.neuvector.com
5 changes: 5 additions & 0 deletions docs/components/rancher.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Rancher
---

https://ranchermanager.docs.rancher.com
3 changes: 3 additions & 0 deletions docs/components/sle-micro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: SLE Micro
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could link https://www.suse.com/products/micro/ or perhaps better https://documentation.suse.com/sle-micro here?

I've also been wondering if we should test with LeapMicro e.g https://github.com/suse-edge/metal3-demo currently uses Leap, so it would be a more logical move to switch that to LeapMicro for upstream/community usage, or we can just document how to get the SLEMicro image instead (which is probably OK but not ideal from a community perspective).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's chat about this once I'm back from PTO. It's an interesting thought but I'd like to make sure that Leap Micro and SLE Micro maintain the same ABI compatibility that SLES and Leap do.

4 changes: 4 additions & 0 deletions docs/concepts/observability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
sidebar_position: 2
title: Observability
---
12 changes: 12 additions & 0 deletions docs/concepts/terms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Terminology
sidebar_position: 1
---


There is a lot of terminology used in this space. Let's keep track of what means what.

- Kubernetes
- Container
agracey marked this conversation as resolved.
Show resolved Hide resolved
- Cluster API
agracey marked this conversation as resolved.
Show resolved Hide resolved
-
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
sidebar_position: 3
title: Elemental on OSX on Apple Silicon (UTM)
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
sidebar_position: 2
title: K3s on SLE Micro
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
sidebar_position: 1
title: SLE Micro on OSX on Apple Silicon (UTM)
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
sidebar_position: 1
title: SLE Micro on X86_64 on libvirt (virt-install)
---

Expand Down
7 changes: 6 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
---
sidebar_label: Overview
sidebar_label: Start Here!
title: ''
---

# Overview

Welcome to the **SUSE Edge Engineering** docs.

:::warning
We suggest you to please put on your hard hat, as we are rapidly building out our documentation.
:::


ATIP documentation can be found [here](/docs/product/atip/introduction)
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
sidebar_position: 1
title: Create a package (RPM or Container image) using OBS (openSUSE Build Service)
---

Expand All @@ -8,7 +7,7 @@ import TabItem from "@theme/TabItem";

## openSUSE Build Service

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For now this seems fine in the integrations section, but I wonder if we need a separate development section for this kind of content and other contributor guidelines?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, let's chat about where to put contributor guides separately

The [openSUSE Build Service](https://build.opensuse.org) is the public instance of the [Open Build Service](https://openbuildservice.org/) used for development of the openSUSE distribution and to offer packages from same source for Fedora, Debian, Ubuntu, SUSE Linux Enterprise and other distributions..
The [openSUSE Build Service](https://build.opensuse.org) is the public instance of the [Open Build Service](https://openbuildservice.org/) used for development of the openSUSE distribution and to offer packages from same source for Fedora, Debian, Ubuntu, SUSE Linux Enterprise and other distributions.

This service is also able to build container images, using either a `Dockerfile` or a KIWI configuration.

Expand Down Expand Up @@ -58,7 +57,7 @@ osc meta prj -e "home:$USERNAME:$PROJECTNAME"

:::note

If you want to use your home project root just specify `home:$USERNAME` here and in following steps
If you want to use your home project root just specify `home:$USERNAME` here and in following steps.

:::

Expand All @@ -71,13 +70,12 @@ In the editor you can now fill the metadata to look similar to this:
<person userid="$USERNAME" role="maintainer"/>
<!--
If you want to build RPM packages you need a block like this one, here for
SLE-15 SP4 replace accordingly to the distribution you want to target
SLE-15 SP5 replace accordingly to the distribution you want to target
-->
<repository name="sp4">
<path project="SUSE:SLE-15-SP4:Update" repository="standard"/>
<path project="SUSE:SLE-15-SP4:GA" repository="standard"/>
<repository name="sp5">
<path project="SUSE:SLE-15-SP5:Update" repository="standard"/>
<path project="SUSE:SLE-15-SP5:GA" repository="standard"/>
<arch>x86_64</arch>
<arch>s390x</arch>
<arch>aarch64</arch>
</repository>
<!-- If you want to build container images you need a block akin to this one -->
Expand All @@ -88,14 +86,13 @@ In the editor you can now fill the metadata to look similar to this:
-->
<path project="SUSE:Registry" repository="standard"/>
<!--
These defines package repositories available during build, I am
This defines package repositories available during build, I am
refering to the one above here so I can use the RPM packages published
in this project for the container images of the project
-->
<path project="home:$USERNAME:$PROJECTNAME" repository="sp4"/>
<!-- This is the list of architecture you want to build for -->
<arch>x86_64</arch>
<arch>s390x</arch>
<arch>aarch64</arch>
</repository>
</project>
Expand All @@ -107,7 +104,7 @@ If you want to build containers you need to tweak the configuration of the proje
osc meta prjconf -e "home:$USERNAME:$PROJECTNAME"
```

The configration is different whether you want to use KIWI or Dockerfile build system:
The configuration is different whether you want to use KIWI or Dockerfile build system:

<Tabs groupId="buildtype">
<TabItem value="docker" label="Dockerfile">
Expand Down
3 changes: 3 additions & 0 deletions docs/integrations/linkerd.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Using the Linkerd Service Mesh
---
3 changes: 1 addition & 2 deletions docs/quickstart/nats.md → docs/integrations/nats.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
sidebar_position: 6
title: NATS on K3s
title: Setting up NATS on K3s
---

# Intro
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
sidebar_position: 8
title: NVIDIA GPU's on SLE Micro
title: Using NVIDIA GPU's on SLE Micro
---

# Intro
Expand Down
File renamed without changes.
File renamed without changes.
78 changes: 0 additions & 78 deletions docs/misc/slemicro-vs-slemicro-rancher.md

This file was deleted.

27 changes: 27 additions & 0 deletions docs/quickstart/eib.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
sidebar_position: 3
title: Standalone Clusters with Edge Image Builder
---

## What is the Edge Image Builder?

## Why use this method

## How to use the Edge Image Builder

### Installing Rancher Desktop or Podman

### Building config file

### Running the application

### Using your newly built image

### Updating your system while airgapped

## Next steps

## Planned changes

## Additional Resources

27 changes: 27 additions & 0 deletions docs/quickstart/elemental.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
sidebar_position: 5
title: Remote host onboarding with Elemental
---

## What is Elemental?

## Why use this method

## High level architecture

## How to use Elemental

### Setup bootstrap cluster

### Build installation media

### Add systems

### Create downstream clusters


## Next steps

## Planned changes

## Additional Resources
25 changes: 25 additions & 0 deletions docs/quickstart/metal3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
sidebar_position: 4
title: BMC automated deployments with Metal3
---

## What is Metal<sup>3</sup>?

## Why use this method

## High level architecture

## How to use Metal3

### Setup bootstrap cluster

### Add systems

### Create downstream clusters


## Next steps

## Planned changes

## Additional Resources
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading