Skip to content

Commit 25cde13

Browse files
authored
Add redirect for old CoC link (#28)
1 parent cab5243 commit 25cde13

File tree

2 files changed

+68
-1
lines changed

2 files changed

+68
-1
lines changed

README.md

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,67 @@
11
# beeware.org
22

3-
The BeeWare website.
3+
This is the homepage for the [BeeWare project](http://beeware.org).
4+
5+
It is a [MkDocs](https://mkdocs.org)-based site.
6+
7+
## Getting started
8+
9+
To view a local build of this website, create a virtual environment, and install the development requirements:
10+
11+
```sh
12+
$ python3 -m venv venv
13+
$ source venv/bin/activate
14+
(venv) $ python -m pip install --group dev
15+
```
16+
17+
Then from the root directory of the checkout, run:
18+
19+
```sh
20+
(venv) $ tox -e docs-live
21+
```
22+
23+
This will [start a web server](http://127.0.0.1:8042) that will automatically reload whenever you make a change to site content. This will only build the English version of the site; to build and test the *full* site, run:
24+
25+
```sh
26+
(venv) $ tox -e docs-all,docs-serve
27+
```
28+
29+
This will also [start a web server](http://127.0.0.1:8042); however the content will *not* automatically reload.
30+
31+
## Financial support
32+
33+
The BeeWare project would not be possible without the generous support of our financial members:
34+
35+
[![Anaconda logo](https://beeware.org/images/anaconda-dark.png)](https://anaconda.com/)
36+
37+
Anaconda Inc. - Advancing AI through open source.
38+
39+
Plus individual contributions from [users like you](https://beeware.org/community/members/). If you find Briefcase, or other BeeWare tools useful, please consider becoming a financial member.
40+
41+
## Community
42+
43+
You can talk to the community through:
44+
45+
- [@beeware@fosstodon.org on Mastodon](https://fosstodon.org/@beeware)
46+
- BeeWare Discord server: [Discord](https://beeware.org/bee/chat/)
47+
- [Tickets on the website issue tracker](https://github.com/beeware/website/issues)
48+
49+
### Code of Conduct
50+
51+
The BeeWare community has a strict [Code of Conduct](https://beeware.org/community/code-of-conduct/). All users and developers are expected to adhere to this code.
52+
53+
If you have any concerns about this code of conduct, or you wish to report a violation of this code, please contact the project founder [Russell Keith-Magee](mailto:russell@keith-magee.com).
54+
55+
### Contributing
56+
57+
If you find problems with this website, [log them on GitHub](https://github.com/beeware/website/issues). If you want to contribute a modification you can fork this repository and submit a pull request.
58+
59+
### Translations
60+
61+
We manage translations using [Weblate](https://weblate.org/). Updates to translated content should be submitted through Weblate, not as PRs to this repository.
62+
63+
<a href="https://hosted.weblate.org/projects/beeware/website/"><img src="https://hosted.weblate.org/widget/beeware/website/open-graph.png" width="300px" alt="Website translation status"></a>
64+
65+
<a href="https://hosted.weblate.org/engage/beeware/"><img src="https://hosted.weblate.org/widget/beeware/website/horizontal-auto.svg" alt="Translation status" /></a>
66+
67+
If you'd like to contribute to the translation effort, join the `#translations` channel on [Discord](https://beeware.org/bee/chat/) and introduce yourself!

docs/config.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,7 @@ plugins:
261261
abstract_chars_count: -1
262262
redirects:
263263
redirect_maps:
264+
# shortlinks
264265
"bee/briefcase-bootstraps.md": "https://briefcase.beeware.org/en/latest/reference/commands/new.html#third-party-bootstraps"
265266
"bee/chat.md": "https://discord.gg/AjYYm8cyQM"
266267
"bee/coc.md": "community/code-of-conduct.md"
@@ -269,3 +270,5 @@ plugins:
269270
"bee/signup.md": "about/contact.md"
270271
"bee/sprint.md": "contributing/sprint-guide.md"
271272
"bee/sprints.md": "contributing/sprint-guide.md"
273+
# Historical links of significance
274+
"community/behavior/code-of-conduct.md": "community/code-of-conduct.md"

0 commit comments

Comments
 (0)