Skip to content

Commit e390b8a

Browse files
authored
Merge branch 'canonical:main' into reviewing-someones-work
2 parents cd019d8 + 3489c7c commit e390b8a

10 files changed

+409
-82
lines changed

ubuntu-desktop/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
For over 20 years, the Ubuntu Linux desktop has been one of the most popular
2+
Linux distributions, and the gateway to Linux and open source for millions of
3+
users. Its success has always been due to a tight collaboration between the
4+
Ubuntu community and Canonical, and the documentation that accompanies each and
5+
every release.
6+
7+
The Ubuntu Desktop documentation, however, is showing signs of its age. Many
8+
users find that it's spread across too many different locations. Topics can be
9+
difficult to find, difficult to follow, and sometimes out-of-date. To help
10+
solve these problems, Canonical is in the very early stages of prototyping a
11+
new platform that we hope will be the foundation for the Ubuntu Desktop
12+
documentation for the next 20 years, and beyond. This represents a wonderful
13+
and exciting opportunity for the Open Documentation Academy, both in supporting
14+
and following what should become a trailblazing documentation platform, and
15+
also in seeding a set of open source community documentation for the next
16+
generation of Ubuntu users.
17+
18+
To start with, several issues related to Desktop will be added to CODA. You can
19+
think of them all as top-level guides, suitable for a beginner who is curious
20+
to know more, but also pointing at more technical content that an advanced user
21+
might pursue further (perhaps these are future CODA issues too). They're broad
22+
because we want to invoke the more creative side of technical writing. Many of
23+
your readers will be ordinary users, and their skill levels (and patience) will
24+
vary hugely.
25+
26+
This is an excellent opportunity to get involved at the beginning of what we
27+
hope will be a major project to improve Desktop documentation in the coming
28+
years. The initial topics that we have selected will give you opportunities to
29+
stretch your writing muscles in new ways, often requiring you to connect ideas
30+
and explain them for the general user
31+
32+
To get started, just take a look for tasks with the 'desktop' label in our task
33+
tracker.

website/.custom_wordlist.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,7 @@ scalable
3838
Snapcraft
3939
SSL
4040
WSL
41+
Hackmamba
42+
Coursera
43+
specializes
44+
Center

website/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
#
2424
# TODO: Update with the official name of your project or product
2525

26-
project = "CODA"
26+
project = "Open Documentation Academy"
2727
author = "Canonical Ltd."
2828

2929

website/library/reference/links-for-technical-writers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
- [Google Style Guides](https://google.github.io/styleguide/): guides on style for languages from AngularJS to Vim script.
2121
- [Diátaxis](https://diataxis.fr/): a systematic approach to technical documentation authoring.
2222
- [Introduction to DITA](https://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/archSpec/base/introduction-to-dita.html#introduction-to-dita): an open standard and architecture for technical information.
23-
- [Technical Writing Resources](https://developers.google.com/tech-writing/resources): resources and style guides from Google for developerss.
23+
- [Technical Writing Resources](https://developers.google.com/tech-writing/resources): resources and style guides from Google for developers.
2424
- [What is a Technical Writer Style Guide? With Examples](https://document360.com/blog/technical-writer-style-guide/): guide with style examples from Document360.
2525

2626
## Frameworks

0 commit comments

Comments
 (0)