From 8f10725563c7da0ca4fa29a5180011528d971867 Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Wed, 6 Apr 2022 09:09:08 +0800 Subject: [PATCH 1/3] Remove references to RST. --- BeeWare.lektorproject | 1 - README.md | 94 +++++++++++++++++++++++++++++++++ README.rst | 108 -------------------------------------- assets/README.md | 93 ++++++++++++++++++++++++++++++++ assets/README.rst | 93 -------------------------------- flowblocks/text-block.ini | 6 +-- models/blog-post.ini | 4 +- models/blog.ini | 4 +- models/event.ini | 4 +- models/events.ini | 4 +- models/home.ini | 4 +- models/member.ini | 8 +-- models/members.ini | 4 +- models/page.ini | 8 +-- models/project-type.ini | 4 +- models/project.ini | 16 +++--- models/resource.ini | 4 +- models/resources.ini | 12 ++--- models/team-member.ini | 4 +- models/team.ini | 4 +- 20 files changed, 232 insertions(+), 247 deletions(-) create mode 100644 README.md delete mode 100644 README.rst create mode 100644 assets/README.md delete mode 100644 assets/README.rst diff --git a/BeeWare.lektorproject b/BeeWare.lektorproject index 0a95cd3a2c..71990db629 100644 --- a/BeeWare.lektorproject +++ b/BeeWare.lektorproject @@ -70,7 +70,6 @@ url_prefix = /pl_PL/ locale = pl_PL [packages] -lektor-rst = 0.2.0 lektor-github-repos = 0.1.1 lektor-gravatar = 0.1.2 diff --git a/README.md b/README.md new file mode 100644 index 0000000000..c65935f64c --- /dev/null +++ b/README.md @@ -0,0 +1,94 @@ +[![image](http://beeware.org/static/images/brutus-270.png){width="72px"}](https://beeware.org) + +# beeware.github.io + +This is the homepage for the [BeeWare project](http://beeware.org). + +It is a [Lektor](https://getlektor.com)-based site. + +If you want to contribute a modification, you can fork this repository +and submit a pull request. However, **do not fork the master branch** - +fork the [lektor +branch](https://github.com/beeware/beeware.github.io/tree/lektor) and +make changes there instead. + +If you want to test out a change before you submit it, create a virtual +environment, and install [Lektor](https://getlektor.com): + + $ python3 -m venv venv + $ source venv/bin/activate + (venv) $ python -m pip install lektor + +Then from the root directory of the checkout, run: + + (venv) $ lektor server + +This will [start a webserver](http://127.0.0.1:5000) that will +autoreload whenever you make a change to site content. + +## Community + +You can talk to the community through: + +- [\@pybeeware on Twitter](https://twitter.com/pybeeware) +- BeeWare Gitter channel: + [beeware/general](https://gitter.im/beeware/general) +- [Tickets on the beeware.github.io issue + tracker](https://github.com/beeware/beeware.github.io/issues) + +## Contributing + +If you find problems with this website, [log them on +GitHub](https://github.com/beeware/beeware.github.io/issues). If you +want to contribute, please [fork the +code](https://github.com/beeware/beeware.github.io/tree/lektor) and +[submit a pull +request](https://github.com/beeware/beeware.github.io/pulls). + +Before submitting a pull request, please make sure your forked branch is +up to date with the original branch. To do this: + +- set your upstream remote: + + $ git remote add upstream https://github.com/beeware/beeware.github.io.git + +- make sure you have the latest changes from upstream: + + $ git fetch upstream + +- rebase your **lektor** branch to **upstream** before pushing to git + and submitting a pull request: + + $ git rebase upstream/lektor + +## Translating + +Want to make BeeWare more accessible to non-English-speakers? Help +translate the site! Steps are as follows: + +1. Add language specification to + [BeeWare.lektorproject](https://github.com/beeware/beeware.github.io/blob/lektor/BeeWare.lektorproject). + + Fill out the name of the language, its url prefix, and the locale. + Make sure you use the correct [ISO + 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) locale + code - for many countries, it\'s not the same as the national TLD. + For example, the ISO 639-1 Danish locale is \'da\', but Denmark uses + the \'.dk\' TLD. + +2. Add an entry for your language to the [Atom + configuration](https://github.com/beeware/beeware.github.io/blob/lektor/configs/atom.ini). + +3. Add your first translation, by translating the names for the menus + at the top of each page. Edit [the menus translation + file](https://github.com/beeware/beeware.github.io/blob/lektor/databags/menu.ini), + adding a block for your language. + +4. Start adding translations for content pages on the site. Translated + files are at the same directory level as the primary English files, + but have a language suffix. For example, Arabic\'s locale is \'ar\', + so you would add [contents+ar.lr]{.title-ref} wherever the original + file name is [contents.lr]{.title-ref} + +A great place to start translating is the [contributing +section](https://beeware.org/contributing/). diff --git a/README.rst b/README.rst deleted file mode 100644 index 85af17837d..0000000000 --- a/README.rst +++ /dev/null @@ -1,108 +0,0 @@ -.. image:: http://beeware.org/static/images/brutus-270.png - :width: 72px - :target: https://beeware.org - -beeware.github.io -================= - -This is the homepage for the `BeeWare project`_. - -It is a `Lektor`_-based site. - -If you want to contribute a modification, you can fork this repository and -submit a pull request. However, **do not fork the master branch** - fork the -`lektor branch`_ and make changes there instead. - -.. _lektor branch: https://github.com/beeware/beeware.github.io/tree/lektor - -If you want to test out a change before you submit it, create a virtual -environment, and install `Lektor`_:: - - $ python3 -m venv venv - $ source venv/bin/activate - (venv) $ python -m pip install lektor - -Then from the root directory of the checkout, run:: - - (venv) $ lektor server - -.. _Lektor: https://getlektor.com - -This will `start a webserver`_ that will autoreload whenever you make a change -to site content. - -.. _start a webserver: http://127.0.0.1:5000 - -Community ---------- - -You can talk to the community through: - -* `@pybeeware on Twitter`_ - -* BeeWare Gitter channel: `beeware/general`_ - -* `Tickets on the beeware.github.io issue tracker`_ - -Contributing ------------- - -If you find problems with this website, `log them on GitHub`_. If you -want to contribute, please `fork the code`_ and `submit a pull request`_. - -Before submitting a pull request, please make sure your forked branch is up -to date with the original branch. To do this: - -- set your upstream remote:: - - $ git remote add upstream https://github.com/beeware/beeware.github.io.git - -- make sure you have the latest changes from upstream:: - - $ git fetch upstream - -- rebase your **lektor** branch to **upstream** before pushing to git and - submitting a pull request:: - - $ git rebase upstream/lektor - - -.. _BeeWare project: http://beeware.org -.. _@pybeeware on Twitter: https://twitter.com/pybeeware -.. _beeware/general: https://gitter.im/beeware/general -.. _Tickets on the beeware.github.io issue tracker: https://github.com/beeware/beeware.github.io/issues -.. _log them on Github: https://github.com/beeware/beeware.github.io/issues -.. _fork the code: https://github.com/beeware/beeware.github.io/tree/lektor -.. _submit a pull request: https://github.com/beeware/beeware.github.io/pulls - - -Translating ------------ - -Want to make BeeWare more accessible to non-English-speakers? Help translate -the site! Steps are as follows: - -1. Add language specification to `BeeWare.lektorproject - `_. - - Fill out the name of the language, its url prefix, and the locale. Make sure - you use the correct `ISO 639-1 - `_ locale code - for - many countries, it's not the same as the national TLD. For example, the ISO - 639-1 Danish locale is 'da', but Denmark uses the '.dk' TLD. - -2. Add an entry for your language to the `Atom configuration - `_. - -3. Add your first translation, by translating the names for the menus at the - top of each page. Edit `the menus translation file - `_, - adding a block for your language. - -4. Start adding translations for content pages on the site. Translated files - are at the same directory level as the primary English files, but have a - language suffix. For example, Arabic's locale is 'ar', so you would add - `contents+ar.lr` wherever the original file name is `contents.lr` - -A great place to start translating is the `contributing section -`_. diff --git a/assets/README.md b/assets/README.md new file mode 100644 index 0000000000..c9ecc00a9a --- /dev/null +++ b/assets/README.md @@ -0,0 +1,93 @@ +[![image](http://beeware.org/static/images/brutus-270.png){width="72px"}](https://beeware.org) + +# beeware.github.io + +This is the homepage for the [BeeWare project](http://beeware.org). + +It is a [Lektor](https://getlektor.com)-based site. + +If you want to contribute a modification, you can fork this repository +and submit a pull request. However, **do not fork the master branch** - +fork the [lektor +branch](https://github.com/beeware/beeware.github.io/tree/lektor) and +make changes there instead. + +If you want to test out a change before you submit it, download and +install [Lektor](https://getlektor.com) (note: currently it\'s better to +use Lektor with Python 2.7): + +> \$ pip install lektor + +Then from the root directory of the checkout, run: + +> \$ lektor server + +This will [start a webserver](http://127.0.0.1:5000) that will +autoreload whenever you make a change to site content. + +## Community + +You can talk to the community through: + +- [\@pybeeware on Twitter](https://twitter.com/pybeeware) +- BeeWare Gitter channel: + [beeware/general](https://gitter.im/beeware/general) +- [Tickets on the beeware.github.io issue + tracker](https://github.com/beeware/beeware.github.io/issues) + +## Contributing + +If you find problems with this website, [log them on +GitHub](https://github.com/beeware/beeware.github.io/issues). If you +want to contribute, please [fork the +code](https://github.com/beeware/beeware.github.io/tree/lektor) and +[submit a pull +request](https://github.com/beeware/beeware.github.io/pulls). + +Before submitting a pull request, please make sure your forked branch is +up to date with the original branch. To do this: + +- set your upstream remote: + + $ git remote add upstream https://github.com/beeware/beeware.github.io.git + +- make sure you have the latest changes from upstream: + + $ git fetch upstream + +- rebase your **lektor** branch to **upstream** before pushing to git + and submitting a pull request: + + $ git rebase upstream/lektor + +## Translating + +Want to make BeeWare more accessible to non-English-speakers? Help +translate the site! Steps are as follows: + +1. Add language specification to + [BeeWare.lektorproject](https://github.com/beeware/beeware.github.io/blob/lektor/BeeWare.lektorproject). + + Fill out the name of the language, its url prefix, and the locale. + Make sure you use the correct [ISO + 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) locale + code - for many countries, it\'s not the same as the national TLD. + For example, the ISO 639-1 Danish locale is \'da\', but Denmark uses + the \'.dk\' TLD. + +2. Add an entry for your language to the [Atom + configuration](https://github.com/beeware/beeware.github.io/blob/lektor/configs/atom.ini). + +3. Add your first translation, by translating the names for the menus + at the top of each page. Edit [the menus translation + file](https://github.com/beeware/beeware.github.io/blob/lektor/databags/menu.ini), + adding a block for your language. + +4. Start adding translations for content pages ont he site. Translated + files are at the same directory level as the primary English files, + but have a language suffix. For example, Arabic\'s locale is \'ar\', + so you would add [contents+ar.lr]{.title-ref} wherever the original + file name is [contents.lr]{.title-ref} + +A great place to start translating is the [contributing +section](beeware.github.io/content/contributing). diff --git a/assets/README.rst b/assets/README.rst deleted file mode 100644 index 0d4cf0cf9e..0000000000 --- a/assets/README.rst +++ /dev/null @@ -1,93 +0,0 @@ -.. image:: http://beeware.org/static/images/brutus-270.png - :width: 72px - :target: https://beeware.org - -beeware.github.io -================= - -This is the homepage for the `BeeWare project`_. - -It is a `Lektor`_-based site. - -If you want to contribute a modification, you can fork this repository and -submit a pull request. However, **do not fork the master branch** - fork the -`lektor branch`_ and make changes there instead. - -.. _lektor branch: https://github.com/beeware/beeware.github.io/tree/lektor - -If you want to test out a change before you submit it, download and install -`Lektor`_ (note: currently it's better to use Lektor with Python 2.7): - - $ pip install lektor - -Then from the root directory of the checkout, run: - - $ lektor server - -.. _Lektor: https://getlektor.com - -This will `start a webserver`_ that will autoreload whenever you make a change -to site content. - -.. _start a webserver: http://127.0.0.1:5000 - -Community ---------- - -You can talk to the community through: - -* `@pybeeware on Twitter`_ - -* BeeWare Gitter channel: `beeware/general`_ - -* `Tickets on the beeware.github.io issue tracker`_ - -Contributing ------------- - -If you find problems with this website, `log them on GitHub`_. If you -want to contribute, please `fork the code`_ and `submit a pull request`_. - -Before submitting a pull request, please make sure your forked branch is up -to date with the original branch. To do this: - -- set your upstream remote:: - - $ git remote add upstream https://github.com/beeware/beeware.github.io.git - -- make sure you have the latest changes from upstream:: - - $ git fetch upstream - -- rebase your **lektor** branch to **upstream** before pushing to git and - submitting a pull request:: - - $ git rebase upstream/lektor - - -.. _BeeWare project: http://beeware.org -.. _@pybeeware on Twitter: https://twitter.com/pybeeware -.. _beeware/general: https://gitter.im/beeware/general -.. _Tickets on the beeware.github.io issue tracker: https://github.com/beeware/beeware.github.io/issues -.. _log them on Github: https://github.com/beeware/beeware.github.io/issues -.. _fork the code: https://github.com/beeware/beeware.github.io/tree/lektor -.. _submit a pull request: https://github.com/beeware/beeware.github.io/pulls - - -Translating ------------ - -Want to make BeeWare more accessible to non-English-speakers? Help translate the site! Steps are as follows: - -1. Add language specification to `BeeWare.lektorproject `_. - - Fill out the name of the language, its url prefix, and the locale. Make sure you use the correct `ISO 639-1 `_ locale code - for many countries, it's not the same as - the national TLD. For example, the ISO 639-1 Danish locale is 'da', but Denmark uses the '.dk' TLD. - -2. Add an entry for your language to the `Atom configuration `_. - -3. Add your first translation, by translating the names for the menus at the top of each page. Edit `the menus translation file `_, adding a block for your language. - -4. Start adding translations for content pages ont he site. Translated files are at the same directory level as the primary English files, but have a language suffix. For example, Arabic's locale is 'ar', so you would add `contents+ar.lr` wherever the original file name is `contents.lr` - -A great place to start translating is the `contributing section `_. diff --git a/flowblocks/text-block.ini b/flowblocks/text-block.ini index fdeb5af13f..b1b69ffa1f 100644 --- a/flowblocks/text-block.ini +++ b/flowblocks/text-block.ini @@ -9,11 +9,11 @@ type = markdown [fields.text] label = Text -description = reStructuredText -type = rst +description = Markdown +type = markdown [fields.image] -label = Image +label = Image type = select source = record.attachments.images width = 1/4 diff --git a/models/blog-post.ini b/models/blog-post.ini index b7a4f4bca7..44a32e5f62 100644 --- a/models/blog-post.ini +++ b/models/blog-post.ini @@ -26,5 +26,5 @@ width = 1/4 [fields.body] label = Body -description = reStructuredText -type = rst +description = Markdown +type = markdown diff --git a/models/blog.ini b/models/blog.ini index 44f9f8bcce..3b7bd88e39 100644 --- a/models/blog.ini +++ b/models/blog.ini @@ -21,5 +21,5 @@ type = string [fields.gutter_top] label = Gutter top -description = reStructuredText -type = rst +description = Markdown +type = markdown diff --git a/models/event.ini b/models/event.ini index efd19c2122..e34065afa6 100644 --- a/models/event.ini +++ b/models/event.ini @@ -43,5 +43,5 @@ type = string [fields.description] label = Description -description = reStructuredText -type = rst +description = Markdown +type = markdown diff --git a/models/events.ini b/models/events.ini index 9e5e7f6a11..1beac768b5 100644 --- a/models/events.ini +++ b/models/events.ini @@ -13,8 +13,8 @@ type = string [fields.gutter] label = Gutter -description = reStructuredText -type = rst +description = Markdown +type = markdown [children] model = event diff --git a/models/home.ini b/models/home.ini index f92b23829f..65f68c3c3d 100644 --- a/models/home.ini +++ b/models/home.ini @@ -15,8 +15,8 @@ type = string [fields.description] label = Description -description = reStructuredText -type = rst +description = Markdown +type = markdown [fields.header] label = Header blocks diff --git a/models/member.ini b/models/member.ini index 12c5973bba..d97615a426 100644 --- a/models/member.ini +++ b/models/member.ini @@ -52,10 +52,10 @@ width = 1/4 [fields.description] label = Description -description = reStructuredText -type = rst +description = Markdown +type = markdown [fields.contribution] label = Contribution -description = reStructuredText -type = rst +description = Markdown +type = markdown diff --git a/models/members.ini b/models/members.ini index b3af3373b5..2f98647c39 100644 --- a/models/members.ini +++ b/models/members.ini @@ -21,8 +21,8 @@ type = string [fields.body] label = Body -description = reStructuredText -type = rst +description = Markdown +type = markdown [fields.sort_key] label = Sort order diff --git a/models/page.ini b/models/page.ini index c7a86ad86f..ef7dad3683 100644 --- a/models/page.ini +++ b/models/page.ini @@ -15,13 +15,13 @@ type = string [fields.body] label = Body -description = reStructuredText -type = rst +description = Markdown +type = markdown [fields.gutter] label = Gutter -description = reStructuredText -type = rst +description = Markdown +type = markdown [fields.incomplete] label = Is this page incomplete? diff --git a/models/project-type.ini b/models/project-type.ini index c1136784e4..9fb5aef4b8 100644 --- a/models/project-type.ini +++ b/models/project-type.ini @@ -21,5 +21,5 @@ type = string [fields.description] label = Description -description = reStructuredText -type = rst +description = Markdown +type = markdown diff --git a/models/project.ini b/models/project.ini index 95fc190d5d..4a2045a4db 100644 --- a/models/project.ini +++ b/models/project.ini @@ -60,23 +60,23 @@ width = 1/4 [fields.short_description] label = Short description -description = reStructuredText -type = rst +description = Markdown +type = markdown [fields.description] label = Description -description = reStructuredText -type = rst +description = Markdown +type = markdown [fields.pun] label = Pun Reasoning -description = reStructuredText -type = rst +description = Markdown +type = markdown [fields.help_required] label = Help required -description = reStructuredText -type = rst +description = Markdown +type = markdown [fields.incomplete] label = Is this page incomplete? diff --git a/models/resource.ini b/models/resource.ini index 145d42ed38..7e09ebb9a0 100644 --- a/models/resource.ini +++ b/models/resource.ini @@ -33,8 +33,8 @@ width = 1/4 [fields.description] label = Description -description = reStructuredText -type = rst +description = Markdown +type = markdown [fields.url] label = URL diff --git a/models/resources.ini b/models/resources.ini index dc4ed5334b..e825c287e7 100644 --- a/models/resources.ini +++ b/models/resources.ini @@ -22,18 +22,18 @@ type = string [fields.gutter_top] label = Gutter top -description = reStructuredText -type = rst +description = Markdown +type = markdown [fields.gutter] label = Gutter -description = reStructuredText -type = rst +description = Markdown +type = markdown [fields.gutter_bottom] label = Gutter bottom -description = reStructuredText -type = rst +description = Markdown +type = markdown [fields.sort_key] label = Sort order diff --git a/models/team-member.ini b/models/team-member.ini index 3ad32961bc..153daa5168 100644 --- a/models/team-member.ini +++ b/models/team-member.ini @@ -42,8 +42,8 @@ type = date [fields.description] label = Description -description = reStructuredText -type = rst +description = Markdown +type = markdown [fields.superpower] label = Superpowers diff --git a/models/team.ini b/models/team.ini index 901a76193b..9c594f6565 100644 --- a/models/team.ini +++ b/models/team.ini @@ -21,8 +21,8 @@ type = string [fields.body] label = Body -description = reStructuredText -type = rst +description = Markdown +type = markdown [fields.sort_key] label = Sort order From f143322d1eb084abba4db427ae5d6a42b0a34653 Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Wed, 6 Apr 2022 09:40:17 +0800 Subject: [PATCH 2/3] Bump Lektor version. --- requirements.txt | 22 +--------------------- 1 file changed, 1 insertion(+), 21 deletions(-) diff --git a/requirements.txt b/requirements.txt index f5b7003e18..ec0d60ad67 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,22 +1,2 @@ -Lektor==3.3.1 +Lektor==3.3.3 pygments==2.11.2 -# Dependencies that need to be locked for safety -Babel==2.9.1 -charset-normalizer==2.0.12 -click==8.1.2 -ExifRead==2.3.2 -filetype==1.0.10 -Flask==2.1.1 -idna==3.3 -inifile==0.4.1 -itsdangerous==2.1.2 -Jinja2==3.1.1 -Lektor==3.3.1 -MarkupSafe==2.1.1 -mistune==0.8.4 -python-slugify==6.1.1 -requests==2.27.1 -text-unidecode==1.3 -urllib3==1.26.9 -watchdog==2.1.7 -Werkzeug==2.0.3 \ No newline at end of file From 7dab5647a5835eec80572499b22867803aedf683 Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Wed, 6 Apr 2022 09:43:18 +0800 Subject: [PATCH 3/3] Stripped some unncessary content. --- assets/CONTRIBUTING.md | 8 ---- assets/LICENSE | 27 ------------ assets/README.md | 93 ------------------------------------------ 3 files changed, 128 deletions(-) delete mode 100644 assets/CONTRIBUTING.md delete mode 100644 assets/LICENSE delete mode 100644 assets/README.md diff --git a/assets/CONTRIBUTING.md b/assets/CONTRIBUTING.md deleted file mode 100644 index 5aa4f22389..0000000000 --- a/assets/CONTRIBUTING.md +++ /dev/null @@ -1,8 +0,0 @@ -# Contributing - -BeeWare <3's contributions! - -Please be aware, BeeWare operates under a Code of Conduct. - -See [CONTRIBUTING to BeeWare](http://beeware.org/contributing) - diff --git a/assets/LICENSE b/assets/LICENSE deleted file mode 100644 index ba87eb5ea0..0000000000 --- a/assets/LICENSE +++ /dev/null @@ -1,27 +0,0 @@ -Copyright (c) 2017 Russell Keith-Magee. -All rights reserved. - -Redistribution and use in source and binary forms, with or without modification, -are permitted provided that the following conditions are met: - - 1. Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimer. - - 2. Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the distribution. - - 3. Neither the name of BeeWare nor the names of its contributors may - be used to endorse or promote products derived from this software without - specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND -ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR -ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES -(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; -LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON -ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS -SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/assets/README.md b/assets/README.md deleted file mode 100644 index c9ecc00a9a..0000000000 --- a/assets/README.md +++ /dev/null @@ -1,93 +0,0 @@ -[![image](http://beeware.org/static/images/brutus-270.png){width="72px"}](https://beeware.org) - -# beeware.github.io - -This is the homepage for the [BeeWare project](http://beeware.org). - -It is a [Lektor](https://getlektor.com)-based site. - -If you want to contribute a modification, you can fork this repository -and submit a pull request. However, **do not fork the master branch** - -fork the [lektor -branch](https://github.com/beeware/beeware.github.io/tree/lektor) and -make changes there instead. - -If you want to test out a change before you submit it, download and -install [Lektor](https://getlektor.com) (note: currently it\'s better to -use Lektor with Python 2.7): - -> \$ pip install lektor - -Then from the root directory of the checkout, run: - -> \$ lektor server - -This will [start a webserver](http://127.0.0.1:5000) that will -autoreload whenever you make a change to site content. - -## Community - -You can talk to the community through: - -- [\@pybeeware on Twitter](https://twitter.com/pybeeware) -- BeeWare Gitter channel: - [beeware/general](https://gitter.im/beeware/general) -- [Tickets on the beeware.github.io issue - tracker](https://github.com/beeware/beeware.github.io/issues) - -## Contributing - -If you find problems with this website, [log them on -GitHub](https://github.com/beeware/beeware.github.io/issues). If you -want to contribute, please [fork the -code](https://github.com/beeware/beeware.github.io/tree/lektor) and -[submit a pull -request](https://github.com/beeware/beeware.github.io/pulls). - -Before submitting a pull request, please make sure your forked branch is -up to date with the original branch. To do this: - -- set your upstream remote: - - $ git remote add upstream https://github.com/beeware/beeware.github.io.git - -- make sure you have the latest changes from upstream: - - $ git fetch upstream - -- rebase your **lektor** branch to **upstream** before pushing to git - and submitting a pull request: - - $ git rebase upstream/lektor - -## Translating - -Want to make BeeWare more accessible to non-English-speakers? Help -translate the site! Steps are as follows: - -1. Add language specification to - [BeeWare.lektorproject](https://github.com/beeware/beeware.github.io/blob/lektor/BeeWare.lektorproject). - - Fill out the name of the language, its url prefix, and the locale. - Make sure you use the correct [ISO - 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) locale - code - for many countries, it\'s not the same as the national TLD. - For example, the ISO 639-1 Danish locale is \'da\', but Denmark uses - the \'.dk\' TLD. - -2. Add an entry for your language to the [Atom - configuration](https://github.com/beeware/beeware.github.io/blob/lektor/configs/atom.ini). - -3. Add your first translation, by translating the names for the menus - at the top of each page. Edit [the menus translation - file](https://github.com/beeware/beeware.github.io/blob/lektor/databags/menu.ini), - adding a block for your language. - -4. Start adding translations for content pages ont he site. Translated - files are at the same directory level as the primary English files, - but have a language suffix. For example, Arabic\'s locale is \'ar\', - so you would add [contents+ar.lr]{.title-ref} wherever the original - file name is [contents.lr]{.title-ref} - -A great place to start translating is the [contributing -section](beeware.github.io/content/contributing).