Skip to content

Commit

Permalink
[docs] oss documentation
Browse files Browse the repository at this point in the history
Change-Id: I5cea3a6333a308a992e3644b1feb323c8c317a48
Reviewed-on: https://fuchsia-review.googlesource.com/c/fuchsia/+/459111
Reviewed-by: Renato Mangini Dias <[email protected]>
Reviewed-by: Nick Van der Auwermeulen <[email protected]>
Reviewed-by: Adam Barth <[email protected]>
  • Loading branch information
Kelly-Ann Dolor authored and mangini committed Dec 8, 2020
1 parent 9d9d369 commit ea2a417
Show file tree
Hide file tree
Showing 36 changed files with 1,802 additions and 146 deletions.
43 changes: 23 additions & 20 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,34 @@
# Contributing to Fuchsia

We'd love to accept your patches and contributions to the Fuchsia project. There are
just a few small guidelines you need to follow.

For the detailed instructions on how to contribute changes,
see the [Contribute changes](/docs/development/source_code/contribute_changes.md) page.
Fuchsia lets anyone contribute to the project, regardless of their employer.
The Fuchsia project reviews and encourages well-tested, high-quality
contributions from anyone who wants to contribute to Fuchsia.

## Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License
Agreement. You (or your employer) retain the copyright to your contribution;
this simply gives us permission to use and redistribute your contributions as
part of the project. Head over to <https://cla.developers.google.com/> to see
your current agreements on file or to sign a new one.
Agreement (CLA).

To see any Contributor License Agreements on file or to sign a CLA, go to <https://cla.developers.google.com/>.

For more information about the Google CLA, see [Contributor License Agreements](https://cla.developers.google.com/about).

## Contributing changes and submitting code reviews

All changes require review, including changes by project members.

For detailed instructions on how to contribute changes,
see [Contribute changes](/docs/development/source_code/contribute_changes.md).

## Community guidelines

You generally only need to submit a CLA once, so if you've already submitted one
(even if it was for a different project), you probably don't need to do it
again.
This project observes the following community guidelines:

## Code reviews
* [Google's Open Source Community Guidelines](https://opensource.google/conduct/)

All submissions, including submissions by project members, require review. We
use [Gerrit](https://fuchsia-review.googlesource.com/) for this purpose. Consult
[Gerrit User Guide](https://gerrit-review.googlesource.com/Documentation/intro-user.html) for more
information on using Gerrit.
* [Fuchsia Code of Conduct](/docs/CODE_OF_CONDUCT.md)

## Community Guidelines
## Governance

This project follows
[Google's Open Source Community Guidelines](https://opensource.google/conduct/).
Review Fuchsia's [Governance](/docs/contribute/governance/governance.md)
statement.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ documentation.
- [Getting started](/docs/get-started/README.md) - everything you need to get started with Fuchsia
- [Development](development/README.md) - instructions for building, running and
testing Fuchsia and software that runs on Fuchsia
- [System](/docs/concepts/README.md) - documentation for how Fuchsia works
- [System](/docs/concepts/index.md) - documentation for how Fuchsia works
- [Zircon](/docs/concepts/kernel/README.md) - documentation for the Zircon kernel
- [Run an example component](/docs/development/run/run-examples.md) - instructions for running examples
on a device
Expand Down
94 changes: 0 additions & 94 deletions docs/concepts/README.md

This file was deleted.

9 changes: 6 additions & 3 deletions docs/concepts/_toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,19 @@
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

# Please, read https://fuchsia.dev/fuchsia-src/community/contribute/docs/documentation_navigation_toc
# Please, read https://fuchsia.dev/fuchsia-src/contribute/docs/documentation-navigation-toc
# before making changes to this file, and add a member of the fuchsia.dev
# team as reviewer.
toc:
- title: "Overview"
path: /docs/concepts
path: /docs/concepts/index.md
- title: "API"
section:
- include: /docs/concepts/api/_toc.yaml
- title: "Architecture"
- title: "Architecture principles"
section:
- include: /docs/concepts/principles/_toc.yaml
- title: "Architecture support"
section:
- include: /docs/concepts/architecture/_toc.yaml
- title: "Bluetooth"
Expand Down
35 changes: 35 additions & 0 deletions docs/concepts/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Overview

Fuchsia is a new open source operating system created at Google
that is currently under active development.
We are building Fuchsia from the kernel up
to meet the needs of today’s growing ecosystem of connected devices.

Fuchsia is still evolving rapidly,
but the underlying principles and values of the system
have remained relatively constant throughout the project.
The core architectural principles guiding Fuchsia’s design and development are:
secure, updatable, inclusive, and pragmatic.

## [Secure](/docs/concepts/principles/secure.md)

All software that runs on Fuchsia receives the least privilege it needs
to perform its job,
and gains access only to information it needs to know.

## [Updatable](/docs/concepts/principles/updatable.md)

Much like the web,
software on Fuchsia is designed to come and go as needed,
and security patches can be pushed to all products on demand.

## [Inclusive](/docs/concepts/principles/inclusive.md)

Fuchsia is an open source project that currently supports a variety
of languages and runtimes, including C++, Rust, Go, Flutter, and Dart.

## [Pragmatic](/docs/concepts/principles/pragmatic.md)

Fuchsia is not a science experiment,
it’s a production-grade operating system that must adhere to fundamentals,
like performance.
2 changes: 1 addition & 1 deletion docs/concepts/kernel/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Zircon

Zircon is the core platform that powers the Fuchsia OS. Zircon is
Zircon is the core platform that powers the Fuchsia. Zircon is
composed of a microkernel (source in [/zircon/kernel](/zircon/kernel)
as well as a small set of userspace services, drivers, and libraries
(source in [/zircon/system/](/zircon/system) necessary for the system
Expand Down
16 changes: 16 additions & 0 deletions docs/concepts/principles/_toc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Copyright 2020 The Fuchsia Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

# Please, read https://fuchsia.dev/fuchsia-src/community/contribute/docs/documentation_navigation_toc
# before making changes to this file, and add a member of the fuchsia.dev
# team as reviewer.
toc:
- title: "Secure"
path: /docs/concepts/principles/secure.md
- title: "Updatable"
path: /docs/concepts/principles/updatable.md
- title: "Inclusive"
path: /docs/concepts/principles/inclusive.md
- title: "Pragmatic"
path: /docs/concepts/principles/pragmatic.md
98 changes: 98 additions & 0 deletions docs/concepts/principles/inclusive.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# Inclusive

Fuchsia is an open source project that is inclusive by design,
from the architecture of the platform
to the open source community that we’re building.

Applying the principles of inclusion
through these dual lenses is a challenge we embrace.
We have not yet achieved all of our goals,
but we’re committed to doing the work to uphold this principle
with the help of our developer community.

## Fuchsia architecture is inclusive by design

### Developers can use their runtime and language of choice

**[Fuchsia Interface Definition Language (FIDL)](/docs/concepts/fidl/overview.md)
allows diverse clients and services to interoperate**

Fuchsia is highly extensible:
developers can create components using the language and environment they prefer.
Both components and FIDL protocols are accessible to any runtime.
Software from different runtimes can integrate together to form a cohesive
experience. Fuchsia simplifies the development model,
making nearly all user space software a component,
from system services to end-user applications.

### Fuchsia is designed to support a wide range of hardware

**[Fuchsia’s Driver Development Kit](/docs/concepts/drivers/overview.md)
allows for a diverse hardware ecosystem**

Fuchsia aims to have a binary-stable interface for drivers.
In this approach,
developers can write drivers once and
these drivers will continue to work as Fuchsia evolves.
There’s no need to modify or recompile drivers when there’s an
update to Fuchsia. This allows for a large hardware ecosystem that
is scalable and easier to maintain.

### Anyone can build and test Fuchsia

**[Fuchsia's emulator (FEMU)](/docs/get-started/set_up_femu.md)
makes it easier for most development environments to run Fuchsia**

FEMU allows you to test Fuchsia components and applications
without needing a Fuchsia device. FEMU looks and behaves like a Fuchsia device,
with the exception that no paving is required.
FEMU simulates different processes and environments
that any developer can use to test and build Fuchsia.

## Open source community

### All developers are welcome to contribute

**[Guidelines and resources](/CONTRIBUTING.md)
are available to help Fuchsia developers**

Google and the Fuchsia team are committed
to preserving and fostering a diverse, inclusive, and welcoming community.
As an open source effort, we welcome high-quality, well-tested contributions
from all. [Our code of conduct](/CODE_OF_CONDUCT.md)
is in place to ensure that community discussions are productive and kind.

### Inclusive language is a core value

**[Respectful code practices](/docs/contribute/respectful_code.md)
reduce harm and bias**

Fuchsia's values include treating each other with dignity.
It’s important that everyone can contribute
without facing the harmful effects of bias and discrimination.
Our respectful code guidelines aim to eliminate terms
that perpetuate discrimination in our codebase, user
interfaces, and documentation.

### Communication channels are open

**[Our bug tracking system](/docs/contribute/report-issue.md)
and [mailing lists](/docs/contribute/community/get-involved.md)
are public**

The open source community can stay informed about Fuchsia updates and progress
by joining our mailing lists.
Fuchsia invites developers to contribute and report issues though our
bug tracking system.
The Fuchsia project uses Gerrit's web-based UI to manage code and
documentation reviews.

### Our roadmap is public

**Fuchsia is a [work in progress](/docs/contribute/roadmap.md)**

As the project evolves,
Fuchsia is striving to be as open as possible about the state of
the code and roadmap. The [Fuchsia RFC process](/docs/contribute/governance/rfcs/README.md)
aims to provide a consistent and transparent path
for making project-wide, technical decisions.
Loading

0 comments on commit ea2a417

Please sign in to comment.