Skip to content

Commit

Permalink
Merge pull request #11942 from ru-fu/doc-fixes-stable-4.0
Browse files Browse the repository at this point in the history
Doc fixes stable 4.0
  • Loading branch information
tomponline authored Jul 10, 2023
2 parents 7e8edd1 + e9b00d8 commit a9ac297
Show file tree
Hide file tree
Showing 23 changed files with 251 additions and 315 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!--
Github issues are used for bug reports. For support questions, please use [our forum](https://discuss.linuxcontainers.org).
Github issues are used for bug reports. For support questions, please use [our forum](https://discourse.ubuntu.com/c/lxd/).
Please fill the template below as it will greatly help us track down your issue and reproduce it on our side.
Please fill the template below as it will greatly help us track down your issue and reproduce it on our side.
Feel free to remove anything which doesn't apply to you and add more information where it makes sense.
-->

Expand Down
2 changes: 1 addition & 1 deletion .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
The LXD team uses GitHub for issue and feature tracking, not for user support.
For information on how to get support, see [Support](https://linuxcontainers.org/lxd/docs/master/support/).
For information on how to get support, see [Support](https://documentation.ubuntu.com/lxd/en/stable-4.0/support/).
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ further defined and clarified by project maintainers.

## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at maintainers@linuxcontainers.org. All
reported by contacting the project team at lxd@lists.canonical.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Check the following guidelines before contributing to the project.

## Pull requests
Changes to this project should be proposed as pull requests on Github
at: <https://github.com/lxc/lxd>
at: <https://github.com/canonical/lxd>

Proposed changes will then go through code review there and once acked,
be merged in the main branch.
Expand Down Expand Up @@ -98,10 +98,10 @@ even when part of a larger set. You may find `git commit -s` useful.

## Code of Conduct

When contributing, you must adhere to the Code of Conduct, which is available at: https://github.com/lxc/lxd/blob/master/CODE_OF_CONDUCT.md
When contributing, you must adhere to the Code of Conduct, which is available at: https://github.com/canonical/lxd/blob/master/CODE_OF_CONDUCT.md

<!-- Include end contributing -->

## More information

For more information, see [Contributing](doc/contributing.md) in the documentation.
For more information, see [Contributing](https://documentation.ubuntu.com/lxd/en/stable-4.0/contributing/) in the documentation.
45 changes: 23 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[![LXD](https://linuxcontainers.org/static/img/containers.png)](https://linuxcontainers.org/lxd)

<!-- Include start LXD intro -->
# LXD
Expand All @@ -8,22 +7,26 @@ It offers a unified user experience around full Linux systems running inside con
It's image based with pre-made images available for a [wide number of Linux distributions](https://images.linuxcontainers.org)
and is built around a very powerful, yet pretty simple, REST API.

To get a better idea of what LXD is and what it does, you can [try it online](https://linuxcontainers.org/lxd/try-it/)!
Then if you want to run it locally, take a look at our [getting started guide](https://linuxcontainers.org/lxd/getting-started-cli/).

- Release announcements: https://linuxcontainers.org/lxd/news/
- Release tarballs: https://linuxcontainers.org/lxd/downloads/
- Documentation: https://linuxcontainers.org/lxd/docs/stable-4.0/

<!-- Include end LXD intro -->

## Get started

See [Getting started](https://documentation.ubuntu.com/lxd/en/stable-4.0/getting_started/) in the LXD documentation for installation instructions and first steps.

- Release announcements: [`https://discourse.ubuntu.com/c/lxd/news/`](https://discourse.ubuntu.com/c/lxd/news/)
- Release tarballs: [`https://github.com/canonical/lxd/releases/`](https://github.com/canonical/lxd/releases/)
- Documentation: [`https://documentation.ubuntu.com/lxd/en/stable-4.0/`](https://documentation.ubuntu.com/lxd/en/stable-4.0/)


## Status
Type | Service | Status
--- | --- | ---
CI (client) | GitHub | [![Build Status](https://github.com/lxc/lxd/workflows/Client%20build%20and%20unit%20tests/badge.svg?branch=stable-4.0)](https://github.com/lxc/lxd/actions)
CI (server) | Jenkins | [![Build Status](https://jenkins.linuxcontainers.org/job/lxd-github-commit/badge/icon)](https://jenkins.linuxcontainers.org/job/lxd-github-commit/)
Go documentation | Godoc | [![GoDoc](https://godoc.org/github.com/lxc/lxd/client?status.svg)](https://godoc.org/github.com/lxc/lxd/client)
Static analysis | GoReport | [![Go Report Card](https://goreportcard.com/badge/github.com/lxc/lxd)](https://goreportcard.com/report/github.com/lxc/lxd)
CI (client) | GitHub | [![Build Status](https://github.com/canonical/lxd/workflows/Client%20build%20and%20unit%20tests/badge.svg?branch=stable-4.0)](https://github.com/canonical/lxd/actions)
CI (server) | GitHub | [![Build Status](https://github.com/canonical/lxd/workflows/Tests/badge.svg?branch=stable-4.0)](https://github.com/canonical/lxd/actions)
Go documentation | Godoc | [![GoDoc](https://godoc.org/github.com/canonical/lxd/client?status.svg)](https://godoc.org/github.com/canonical/lxd/client)
Static analysis | GoReport | [![Go Report Card](https://goreportcard.com/badge/github.com/canonical/lxd)](https://goreportcard.com/report/github.com/canonical/lxd)
Translations | Weblate | [![Translation status](https://hosted.weblate.org/widgets/linux-containers/-/svg-badge.svg)](https://hosted.weblate.org/projects/linux-containers/lxd/)
Project status | CII Best Practices | [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1086/badge)](https://bestpractices.coreinfrastructure.org/projects/1086)

Expand All @@ -38,10 +41,8 @@ Linux | [Snap](https://snapcraft.io/lxd) | snap i
Windows | [Chocolatey](https://chocolatey.org/packages/lxc) | choco install lxc
MacOS | [Homebrew](https://formulae.brew.sh/formula/lxc) | brew install lxc

More instructions on installing LXD for a wide variety of Linux distributions and operating systems [can be found on our website](https://linuxcontainers.org/lxd/getting-started-cli/).
<!-- Include end installing -->

To install LXD from source, see [Installing LXD](doc/installing.md) in the documentation.
For more instructions on installing LXD for a wide variety of Linux distributions and operating systems, and to install LXD from source, see [How to install LXD](https://documentation.ubuntu.com/lxd/en/stable-4.0/installing/) in the documentation.

## Security

Expand All @@ -56,7 +57,7 @@ Consider the following aspects to ensure that your LXD installation is secure:
- Configure your network interfaces to be secure.
<!-- Include end security -->

See [Security](doc/security.md) for detailed information.
See [Security](https://documentation.ubuntu.com/lxd/en/stable-4.0/security/) for detailed information.

**IMPORTANT:**
<!-- Include start security note -->
Expand All @@ -72,26 +73,26 @@ Therefore, you should only give such access to users who you'd trust with root a
The following channels are available for you to interact with the LXD community.

### Bug reports
You can file bug reports and feature requests at: https://github.com/lxc/lxd/issues/new

You can file bug reports and feature requests at: [`https://github.com/canonical/lxd/issues/new`](https://github.com/canonical/lxd/issues/new)

### Forum
A discussion forum is available at: https://discuss.linuxcontainers.org

### Mailing lists
We use the LXC mailing lists for developer and user discussions. You can
find and subscribe to those at: https://lists.linuxcontainers.org
A discussion forum is available at: [`https://discourse.ubuntu.com/c/lxd/`](https://discourse.ubuntu.com/c/lxd/)

### IRC
If you prefer live discussions, you can find us in [#lxc](https://kiwiirc.com/client/irc.libera.chat/#lxc) on irc.libera.chat. See [Getting started with IRC](https://discuss.linuxcontainers.org/t/getting-started-with-irc/11920) if needed.

If you prefer live discussions, you can find us in [`#lxd`](https://web.libera.chat/#lxd) on `irc.libera.chat`. See [Getting started with IRC](https://discuss.linuxcontainers.org/t/getting-started-with-irc/11920) if needed.

### Commercial support

Commercial support for LXD can be obtained through [Canonical Ltd](https://www.canonical.com).

## Documentation
The official documentation is available at: https://linuxcontainers.org/lxd/docs/master/

You can find additional resources on the [website](https://linuxcontainers.org/lxd/articles), on [YouTube](https://www.youtube.com/channel/UCuP6xPt0WTeZu32CkQPpbvA) and in the [Tutorials section](https://discuss.linuxcontainers.org/c/tutorials/) in the forum.
The official documentation is available at: [`https://documentation.ubuntu.com/lxd/en/stable-4.0/`](https://documentation.ubuntu.com/lxd/en/stable-4.0/)

You can find additional resources on the [website](https://ubuntu.com/lxd), on [YouTube](https://www.youtube.com/channel/UCuP6xPt0WTeZu32CkQPpbvA) and in the [Tutorials section](https://discourse.ubuntu.com/c/lxd/tutorials/) in the forum.

<!-- Include end support -->

Expand Down
19 changes: 5 additions & 14 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,9 @@ but we simply do not consider such containers to be root safe.
Unprivileged container escapes are certainly something we'd consider a
security issue, especially if somehow facilitated by LXD.

More details can be found here: https://linuxcontainers.org/lxc/security/
## Ubuntu Security disclosure and embargo policy

## Reporting a vulnerability
The easiest way to report a security issue is by e-mail to:
security@linuxcontainers.org

This e-mail address will reach the three main maintainers for LXC/LXD/LXCFS:
- Christian Brauner
- Stéphane Graber
- Serge Hallyn

We will be working with you to determine whether the issue qualifies as a
security issue, if so in what component and then handle figuring out a
fix, getting a CVE assigned and coordinating the release of the fix to
the various Linux distributions.
See the [Ubuntu Security disclosure and embargo
policy](https://ubuntu.com/security/disclosure-policy) for information
about how to contact the Ubuntu Security Team, what you can expect when
you contact us, and what we expect from you.
Binary file added doc/.sphinx/_static/favicon.ico
Binary file not shown.
Binary file added doc/.sphinx/_static/tag.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
126 changes: 0 additions & 126 deletions doc/.sphinx/_static/version-switcher.js

This file was deleted.

Loading

0 comments on commit a9ac297

Please sign in to comment.