Skip to content

Commit ade61d8

Browse files
committed
cleanup and copy editing for launch of site
1 parent 5142c08 commit ade61d8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+682
-2653
lines changed

docs/about/distro.md

Lines changed: 8 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,29 @@
1-
# the illumos family
1+
# illumos Distributions
22

33
## Introduction
44

55
Similar to other operating systems, there are many different OS distributions
66
based on the common illumos ecosystem.
77

8-
Some of them are maintained by enthusiasts, others are primarily developed by
9-
commercial companies with their own priorities and focus, and some mainly
10-
differ in their packaging systems.
11-
12-
Most of these projects contribute back to the common core set of software, which the
13-
illumos project is all about.
14-
8+
Some distributions are maintained by enthusiasts, while others are primarily
9+
developed by companies with their own priorities and focus.
1510

1611
## Comparison
1712

18-
All illumos-derived systems should include our [common technologies](features.md).
13+
All illumos-derived systems should include our [common
14+
technologies](features.md).
1915

20-
Not all distributions have the latest features or run on both x86 and SPARC.
16+
Not all distributions have the latest features, or run on both x86 and SPARC.
2117

2218
For major feature differences, the following chart may be helpful.
2319

24-
### Active Spins
25-
2620
| Project | Provider | Focus | Linux Comparison | Open Source | Packaging | x86 | SPARC | KVM | LX |
2721
|---------|----------|-------|------------------|-------------|-----------|------|------|-----|----|
28-
| [SmartOS](https://smartos.org) | [Joyent](https://www.joyent.com) | Hypervisor | CoreOS | <i class="material-icons">check</i> | [pkgsrc](https://pkgsrc.joyent.com) | <i class="material-icons">check</i> | | <i class="material-icons">check</i> | <i class="material-icons">check</i> |
2922
| [OmniOS CE](https://www.omniosce.org/) | [OmniOS Community Association](https://omniosce.org/about/about) | Servers | Debian | <i class="material-icons">check</i> | IPS | <i class="material-icons">check</i> | | <i class="material-icons">check</i> | <i class="material-icons">check</i> |
3023
| [OpenIndiana](https://www.openindiana.org/) | [OpenIndiana](https://www.openindiana.org/) | Workstation, Servers | Ubuntu | <i class="material-icons">check</i> | IPS | <i class="material-icons">check</i> | | <i class="material-icons">check</i> | |
24+
| [SmartOS](https://smartos.org) | [Joyent](https://www.joyent.com) | Hypervisor | CoreOS | <i class="material-icons">check</i> | [pkgsrc](https://pkgsrc.joyent.com) | <i class="material-icons">check</i> | | <i class="material-icons">check</i> | <i class="material-icons">check</i> |
3125
| [NexenStor](https://community.nexenta.com/s/) | [Nexenta](https://nexenta.com/) | Storage | | | APT | <i class="material-icons">check</i> | |
3226
| [Tribblix](http://www.tribblix.org/) | Peter Tribble | Workstation, Servers | Slackware | <i class="material-icons">check</i> | SVR4 | <i class="material-icons">check</i> | <i class="material-icons">check</i> | | <i class="material-icons">check</i> | |
3327
| [DilOS](http://www.dilos.org/) | igork | Workstation, Servers | | <i class="material-icons">check</i> | APT | <i class="material-icons">check</i> | <i class="material-icons">check</i> | <i class="material-icons">check</i> | <i class="material-icons">check</i> |
34-
35-
### Unmaintained Spins
36-
37-
| Project | Provider | Focus | Open Source | Packaging | x86 | SPARC |
38-
|---------|----------|-------|-------------|-----------|-----|-------|
39-
| [v9os](http://www.milax.fi/v9os.html) | [MilaX](http://www.milax.fi/) | Server | <i class="material-icons">check</i> | IPS | | <i class="material-icons">check</i> |
4028
| [XStreamOS](http://www.sonicle.com/xstreamos/) | [Sonicle](http://www.sonicle.com/) | Server | | |<i class="material-icons">check</i> | |
29+
| [v9os](http://www.milax.fi/v9os.html) | [MilaX](http://www.milax.fi/) | Server | <i class="material-icons">check</i> | IPS | | <i class="material-icons">check</i> |

docs/about/faq.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
## Quick Links
22

3-
* [Security Information](../security/index.md)
43
* [Manual pages](https://illumos.org/man)
54
* [Mailing lists](../community/lists.md)
65
* [Bug reporting](../user-guide/bugs.md)
@@ -31,16 +30,15 @@ The illumos code base forms the foundation of [distributions](distro.md).
3130
To use the operating system, just download and install one of the
3231
distributions.
3332

34-
To download the source code, review [How To Build
35-
illumos](../developers/index.md). You can also
36-
[browse](https://github.com/illumos/illumos-gate) and
37-
[search](http://src.illumos.org).
33+
To download the source code, review [Building illumos](../developers/build.md).
34+
You can also [browse on GitHub](https://github.com/illumos/illumos-gate) or
35+
[search on OpenGrok](http://src.illumos.org).
3836

3937
## Is illumos free software (open source)?
4038

41-
The bulk of the illumos source code is available under the Common Development
42-
and Distribution License (CDDL), an OSI-approved free software license based on
43-
the Mozilla Public License (MPL).
39+
The bulk of the illumos source code is available under the [Common Development
40+
and Distribution License (CDDL)](https://illumos.org/license/CDDL), an
41+
OSI-approved free software license based on the Mozilla Public License (MPL).
4442

4543
There are some components with other licenses including BSD and MIT. We also
4644
include some software with the GNU General Public License (GPL) or the
@@ -77,7 +75,7 @@ and you're invited to drop in and say "hi!"
7775

7876
## How do I build illumos?
7977

80-
See [How To Build illumos](../developers/index.md).
78+
See [Building illumos](../developers/build.md).
8179

8280
## How do I build a distribution based on illumos?
8381

docs/about/features.md

Lines changed: 37 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,14 @@
33
illumos provides a number of advanced features for downstream distributions and
44
users to utilize.
55

6-
### Filesystems
6+
### OpenZFS
77

8-
#### OpenZFS
9-
10-
We are the canonical upstream for the [OpenZFS Project](http://open-zfs.org/).
8+
The illumos project is part of the community of operating system projects that
9+
ships [OpenZFS](http://open-zfs.org/).
1110

1211
ZFS provides excellent data integrity, performance, flexibility and
13-
ease-of-use you simply can't find in other filesystems. ZFS combines
14-
traditional concepts like volume management and filesystems with a pooled
12+
ease-of-use you simply can't find in other file systems. ZFS combines
13+
traditional concepts like volume management, and file systems with a pooled
1514
storage that does for disks what virtual memory did for RAM.
1615

1716
ZFS was developed at Sun Microsystems in the early 2000s and released as open
@@ -23,10 +22,10 @@ ZFS allows you to:
2322

2423
* Group devices into a single storage pool with various redundancy characteristics
2524
* Create tiered storage with log and cache devices
26-
* Create read-only atomic filesystem snapshots
25+
* Create read-only atomic file system snapshots
2726
* Create writable clones of snapshots
2827
* Send snapshots as a byte stream -- which you can redirect to a file, or send across the network!
29-
* Dynamically modify dataset (filesystem) attributes
28+
* Dynamically modify dataset (file system) attributes
3029
* Delegate dataset management to non-root users or groups
3130

3231
ZFS includes online checksumming of every block, on-demand scrubbing of disks,
@@ -38,50 +37,36 @@ X](https://openzfsonosx.org/) -- and a [Windows
3837
port](https://github.com/openzfsonwindows/ZFSin) is in progress as of late
3938
2017!
4039

41-
#### Others
42-
43-
illumos provides a number of [other filesystems](https://illumos.org/man/7FS/all), including:
44-
45-
* [Loopback](https://illumos.org/man/7FS/lofs)
46-
* [Temporary](https://illumos.org/man/7FS/tmpfs)
47-
* [UFS](https://illumos.org/man/7FS/ufs)
48-
* [HSFS](https://illumos.org/man/7FS/hsfs)
49-
* [NFS](https://illumos.org/man/1M/nfsd)
50-
* [FAT](https://illumos.org/man/7FS/pcfs)
51-
* [CIFS](https://illumos.org/man/7FS/smbfs)
52-
* [UDFS](https://illumos.org/man/7FS/udfs)
53-
5440
### Virtualization
5541

56-
illumos offers a number of virtualization options, including lightweight
57-
"operating system zones", Linux emulated zones, and KVM.
42+
illumos includes a number of virtualization technologies, including:
5843

59-
!!! tip "Terminology"
60-
In illumos, the global context is referred to as the _global zone_, or
61-
_GZ_.
44+
- Zones, a light weight operating system-level virtualization; analogous
45+
to "jails" or "containers" as provided by other systems
46+
- Hardware virtualization
6247

63-
Other zone "brands" are _non-global zones_, _NGZ_, or simply _zones_.
48+
#### Native Zones
6449

65-
#### Native OS
66-
67-
Native OS zones provide an isolated illumos environment to run your
68-
applications in.
50+
Native zones provide an isolated illumos environment to run your applications
51+
in, like having a virtual machine without the hypervisor overhead.
6952

7053
#### LX (Linux Emulation)
7154

72-
LX-branded zones provide the Linux syscall interface allowing you to run most
73-
Linux applications. While not yet upstreamed,
74-
[several illumos distributions](./distro.md) support it.
55+
LX-branded zones provide the Linux system call interface, allowing you to run
56+
most Linux application binaries without recompiling them for illumos. This
57+
facility is available in several illumos distributions, including SmartOS and
58+
OmniOS.
7559

7660
#### KVM
7761

78-
KVM (and QEMU) was ported to illumos in 2011, and can be used on Intel CPUs with
79-
VMX and EPT support.
62+
KVM and QEMU were ported to illumos in 2011, and can be used on Intel CPUs
63+
with VMX and EPT support.
8064

81-
#### bhyve (Under development!)
65+
#### bhyve
8266

83-
Joyent is in the process of porting FreeBSD's bhyve to illumos. It should be
84-
available for testing soon!
67+
Joyent is in the process of porting the bhyve hypervisor from FreeBSD to
68+
illumos. The port is available in at least the SmartOS and OmniOS
69+
distributions.
8570

8671
### Introspection and Debugging
8772

@@ -92,32 +77,28 @@ the operating system, as well as gathering profiling data. DTrace along with MDB
9277
allows you to leverage [CTF data](https://illumos.org/man/4/ctf) to inspect
9378
userland and kernel structures.
9479

95-
#### Modular Debugger
96-
97-
MDB, the illumos modular debugger, allows you to inspect running processes, core
98-
files, kernel state, and kernel crash dumps.
99-
[KMDB](https://illumos.org/man/1/kmdb) also allows controlling the execution of a
100-
running kernel.
80+
#### Modular Debugger (MDB)
10181

102-
### Fault Management
82+
MDB, the illumos modular debugger, allows you to inspect running processes,
83+
core files, kernel state, and kernel crash dumps.
84+
[KMDB](https://illumos.org/man/1/kmdb) also allows controlling the execution of
85+
a running kernel.
10386

104-
### Service Management
87+
### Service Management Facility (SMF)
10588

10689
[SMF](https://illumos.org/man/5/smf) helps administrators manage services
10790
running on the system. SMF can take care of tracking service dependencies,
108-
restart policies, disabling perpetually crashing applications, and more.
91+
supervising and restarting processes, disabling perpetually crashing
92+
applications, and more.
10993

11094
### Firewall
11195

112-
illumos uses [ipfilter](https://illumos.org/man/5/ipfilter) for firewalling. Using
113-
ipfilter you can create firewalls not just for the host system, but also for
114-
zones and hardware virtualized systems.
96+
illumos uses [ipfilter](https://illumos.org/man/5/ipfilter) for firewalling.
97+
Using ipfilter you can create firewalls not just for the host system, but also
98+
for zones and hardware virtualized systems.
11599

116100
### Virtual Networking
117101

118102
[dladm(1M)](https://illumos.org/man/1M/dladm) allows users to create Virtual
119-
NICs, bridges, and in some distributions
120-
[overlay networks](https://smartos.org/man/5/overlay).
121-
122-
### Security
123-
103+
NICs, bridges, and in some distributions [overlay
104+
networks](https://smartos.org/man/5/overlay).

docs/about/index.md

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# what *is* illumos?
1+
# What is illumos?
22

33
To quote the [illumos Developer's Guide](https://illumos.org/books/dev/):
44

@@ -11,35 +11,37 @@ To quote the [illumos Developer's Guide](https://illumos.org/books/dev/):
1111
traces it roots back through Sun Microsystems to the original releases of
1212
UNIX and BSD.
1313

14-
illumos itself does not offer an OS distribution -- it is the core from which
15-
[distributions](distro.md) can be created. In this sense, illumos is similar to
16-
a BSD source tree, or Linux's kernel.org.
14+
illumos itself does not offer an OS distribution -- rather, it is the core from
15+
which [distributions](distro.md) can be created. In this sense, illumos is
16+
similar to a BSD source tree, or Linux's kernel.org.
1717

1818
Please see the [history page](history.md) for more information about the
1919
origins of illumos.
2020

21-
### Licensing
21+
### License
2222

23-
illumos is licensed under the [CDDL](https://en.wikipedia.org/wiki/Common_Development_and_Distribution_License).
23+
illumos is available under the [Common Development and Distribution License
24+
(CDDL)](https://illumos.org/license/CDDL).
2425

2526
### Community Values
2627

27-
* Empathy as a core engineering tenet
28-
* Code quality and correctness
28+
* Empathy for users as a core engineering value
29+
* Maintaining code quality through peer review
2930

3031
### Technology Features
3132

32-
The following are shared development tenets and features for distributions utilizing illumos:
33+
The following are shared development tenets and features for distributions
34+
utilizing illumos:
3335

3436
* Stability
3537
* SMP support for many CPUs
36-
* Security multi-user facilities like Roles and Privileges
38+
* Security facilities like Role-based Access Control (RBAC) and Privileges
3739
* Multi-tenancy with Zones
38-
* Unparalleled system introspection with [DTrace](http://dtrace.org/guide/)
39-
* A single pipeline for system issues with the Fault Management Architecture (FMA)
40+
* Deep system introspection with [DTrace](http://dtrace.org/guide/)
41+
* A unified Fault Management Architecture (FMA) for monitoring hardware
4042
* Network virtualization with Crossbow
4143
* Hardware virtualization with KVM
42-
* [Excellent online documentation](https://www.illumos.org/man/)
44+
* [Excellent manual pages](https://illumos.org/man/)
4345
* [Source code for the entire system](https://github.com/illumos/illumos-gate)
4446

4547
For more in-depth descriptions, please see the [features page](features.md).
@@ -55,33 +57,34 @@ are being used for!
5557

5658
### Supported hardware platforms
5759

58-
illumos currently supports:
59-
60-
* i86pc (x86, x86_64) architectures
61-
* AMD64 (except KVM support)
60+
illumos currently best suports 64-bit x86 hardware from Intel and AMD.
6261

6362
There are also several SPARC distributions of illumos; if you are interested in
6463
running illumos on SPARC, please refer directly to those distributions' docs.
6564

6665
To determine if a specific piece of hardware will work with illumos, please
67-
refer to the [Hardware Compatability List](https://www.illumos.org/hcl/).
66+
refer to the [Hardware Compatability List](https://illumos.org/hcl/).
6867

69-
For pre-defined builds of server-grade hardware, you may also refer to
70-
[Joyent Engineering Manufactory
68+
For pre-defined builds of server-grade hardware, you may also refer to [Joyent
69+
Engineering Manufactoring
7170
database](http://eng.joyent.com/manufacturing/bom.html).
7271

7372
### illumos Development Model
7473

75-
Please refer to the [illumos Developer's Guide](https://illumos.org/books/dev/)
76-
and the [development section](../developers/index.md).
74+
Please refer to the [illumos Developer's
75+
Guide](https://illumos.org/books/dev/), as well as the [Building
76+
illumos](../developers/build.md) and [contribution](../contributing/index.md)
77+
sections of this documentation.
7778

7879
### Contributing to illumos
7980

80-
Please see the [contribution](../contributing/index.md) if you'd like to
81-
participate in the project.
81+
Please see the [community](../community/index.md) and
82+
[contribution](../contributing/index.md) guides if you'd like to participate in
83+
the project.
8284

8385
### Third Party Software
8486

85-
illumos does not itself ship third party software, or contain software like webservers and so forth.
87+
illumos does not itself ship third party software, or contain software like
88+
webservers and so forth.
8689

8790
Distributions include their own package management.

docs/about/leadership.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ Council, and Request To Integrate (RTI) Advocates.
88
The Dev Council is a technical steering committee drawn from well-known
99
developers of Solaris, whose role is to make high-level architecture decisions.
1010

11-
| Member | Organization |
12-
| --------------- | ------------ |
13-
| Adam Leventhal | Delphix |
14-
| Bryan Cantrill | Joyent |
15-
| Garrett D'Amore | unaffiliated |
16-
| Gordon Ross | Nexenta |
17-
| Rich Lowe | unaffiliated |
11+
| Member | Organization |
12+
| --------------- | --------------- |
13+
| Adam Leventhal | Transposit |
14+
| Bryan Cantrill | Joyent |
15+
| Garrett D'Amore | RackTop Systems |
16+
| Gordon Ross | Nexenta |
17+
| Rich Lowe | unaffiliated |
1818

1919
## Advocates
2020

@@ -24,18 +24,18 @@ stability for all illumos users.
2424

2525
Advocates are appointed by the illumos Developer Council.
2626

27-
| Member | Handle | Organization | Expertise |
28-
| ----------------- | ---------- | ------------ | --------- |
29-
| Albert Lee | trisk | SoftNAS | Storage, drivers, userland. |
30-
| Chris Siden | csiden | Delphix | ZFS |
31-
| Dan McDonald | danmcd | Joyent | Cryptography, Networking |
32-
| Garrett D'Amore | gdamore | unaffiliated | Drivers, etc. |
33-
| Gordon Ross | gwr | Nexenta | CIFS/SMB, VFS layer, ZFS ACLs, etc. |
34-
| Hans Rosenfeld | Woodstock | Joyent | Misc. |
35-
| Joshua M. Clulow | LeftWing | Joyent | Misc. |
36-
| Matt Ahrens | mahrens | Delphix | ZFS |
37-
| Rich Lowe | richlowe | unaffiliated | Misc. |
38-
| Robert Mustacchi | rmustacc | Joyent | Virtualization, SMF, PCI, MDB, DTrace, x86 platform, etc. |
27+
| Member | Handle | Organization | Expertise |
28+
| ----------------- | ---------- | --------------- | --------- |
29+
| Albert Lee | trisk | SoftNAS | Storage, drivers, userland. |
30+
| Chris Siden | csiden | Delphix | ZFS |
31+
| Dan McDonald | danmcd | Joyent | Cryptography, Networking |
32+
| Garrett D'Amore | gdamore | RackTop Systems | Drivers, etc. |
33+
| Gordon Ross | gwr | Nexenta | CIFS/SMB, VFS layer, ZFS ACLs, etc. |
34+
| Hans Rosenfeld | Woodstock | Joyent | Misc. |
35+
| Joshua M. Clulow | LeftWing | Joyent | Misc. |
36+
| Matt Ahrens | mahrens | Delphix | ZFS |
37+
| Rich Lowe | richlowe | unaffiliated | Misc. |
38+
| Robert Mustacchi | rmustacc | Joyent | Virtualization, SMF, PCI, MDB, DTrace, x86 platform, etc. |
3939

4040
## Life as an Advocate
4141

docs/about/logo-1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
svg [scalable](../images/logo/PhoenixRGB.svg)<br>eps [scalable](../images/logo/PhoenixRGB.eps)<br>png [64px](../images/logo/Phoenix64x64-RGB.png)<br>png [166px](../images/logo/PhoenixRGB.png)<br>png [2057px](../images/logo/BigHighResPhoenixRGB.png)
1+
<b>Bare Logo:</b><br> svg [scalable](../images/logo/PhoenixRGB.svg)<br>eps [scalable](../images/logo/PhoenixRGB.eps)<br>png [64px](../images/logo/Phoenix64x64-RGB.png)<br>png [166px](../images/logo/PhoenixRGB.png)<br>png [2057px](../images/logo/BigHighResPhoenixRGB.png)

docs/about/logo-2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
svg scalable optimized for [smaller](../images/logo/SmallPhoenixLogotypeRGB.svg) sizes<br> svg scalable optimized for [larger](../images/logo/LargePhoenixLogotypeRGB.svg) sizes<br> eps scalable optimized for [smaller](../images/logo/DarkSmallPhoenixLogotypeRGB.eps) sizes<br> eps scalable optimized for [larger](../images/logo/LargePhoenixLogotypeRGB.eps) sizes<br> png [90px wide](../images/logo/TinyPhoenixLogotypeRGB.png)<br> png [139px wide](../images/logo/SmallPhoenixLogotypeRGB.png)<br> png [267px wide](../images/logo/MediumPhoenixLogotypeRGB.png)<br> png [3320px wide](../images/logo/BigHighResPhoenixLogotypeRGB.png)<br>
1+
<b>Logo with text, light background:</b><br> svg scalable optimized for [smaller](../images/logo/SmallPhoenixLogotypeRGB.svg) sizes<br> svg scalable optimized for [larger](../images/logo/LargePhoenixLogotypeRGB.svg) sizes<br> eps scalable optimized for [smaller](../images/logo/DarkSmallPhoenixLogotypeRGB.eps) sizes<br> eps scalable optimized for [larger](../images/logo/LargePhoenixLogotypeRGB.eps) sizes<br> png [90px wide](../images/logo/TinyPhoenixLogotypeRGB.png)<br> png [139px wide](../images/logo/SmallPhoenixLogotypeRGB.png)<br> png [267px wide](../images/logo/MediumPhoenixLogotypeRGB.png)<br> png [3320px wide](../images/logo/BigHighResPhoenixLogotypeRGB.png)<br>

0 commit comments

Comments
 (0)