Skip to content

Commit

Permalink
index: create initial content for documentation page
Browse files Browse the repository at this point in the history
For now this is just the project mission, a quick start guide and the
logo. This will be enhanced over the next couple of days.

Signed-off-by: Stefan Schmidt <[email protected]>
  • Loading branch information
Stefan-Schmidt committed Nov 16, 2023
1 parent 83b029e commit 984278e
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 22 deletions.
3 changes: 2 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
title: Oniro
description: A starter template for a Jeykll site using the Just the Docs theme!
description:
theme: just-the-docs
logo: "/assets/images/oniro-logo.png"

url: https://eclipse-oniro4openharmony.github.io

Expand Down
Binary file added assets/images/oniro-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
58 changes: 37 additions & 21 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,52 @@
---
title: Home
title: Eclipse Oniro4OpenHarmony
layout: home
---
First edit
## Eclipse Oniro4OpenHarmony Documentation

This is a *bare-minimum* template to create a Jekyll site that uses the [Just the Docs] theme. You can easily set the created site to be published on [GitHub Pages]the [README] file explains how to do that, along with other details.
Oniro is an Eclipse Foundation project focused on developing a distributed open source operating system platform that enables interoperability of devices, regardless of brand, make, or model. The platform is designed to be compatible with a broad range of embedded operating system environments, including OpenHarmony, an open source operating system specified and hosted by the OpenAtom Foundation. Managed as an Eclipse Foundation project and working group, Oniro benefits from the Eclipse Foundation's extensive experience in open source governance, along with an advanced IP compliance and licensing toolchain.

If [Jekyll] is installed on your computer, you can also build and preview the created site *locally*. This lets you test changes before committing them, and avoids waiting for GitHub Pages.[^1] And you will be able to deploy your local build to a different platform than GitHub Pages.
Oniro provides the foundational fabric for a wide range of devices, both large and small, offering seamless interoperability, modularization, and a rich graphical user interface. It supports various global technologies and use cases across industries, including Consumer Electronics, Home Appliances, Industrial IoT devices, Smart Homes, and Multimedia.

More specifically, the created site:
----

- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem
- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages
## Quick Start

Other than that, you're free to customize sites that you create with this template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins.
As prerequisites git-lfs and repo need to be installed. 100GB of free disk space
is recommended for the full build.

[Browse our documentation][Just the Docs] to learn more about how to use this theme.
**To obtain the source code use the following commands:**

To get started with creating a site, simply:
```bash
repo init -u https://github.com/eclipse-oniro4openharmony/manifest.git -b OpenHarmony-3.2-Release --no-repo-verify
repo sync -c
repo forall -c 'git lfs pull'
```

1. click "[use this template]" to create a GitHub repository
2. go to Settings > Pages > Build and deployment > Source, and select GitHub Actions
**In the source code directory, fetch the prebuild tools:**

If you want to maintain your docs in the `docs` directory of an existing project repo, see [Hosting your docs from an existing project repo](https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md#hosting-your-docs-from-an-existing-project-repo) in the template README.
```bash
./build/prebuilts_download.sh
```

----
**To run the build an isolated docker container is recommended:**

```bash
docker run -it -v $(pwd):/home/openharmony swr.cn-south-1.myhuaweicloud.com/openharmony-docker/openharmony-docker:1.0.0

```

**In the Docker instance, run the build:**

Select the target device with (e.g.rk3568):

```bash
hb set
```

Start the build:

[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).
```bash
hb build
```

[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
[GitHub Pages]: https://docs.github.com/en/pages
[README]: https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md
[Jekyll]: https://jekyllrb.com
[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate

0 comments on commit 984278e

Please sign in to comment.