Initial step of migration of beeware.org from Lektor to MkDocs

.github/dependabot.yml

@@ -0,0 +1,19 @@
+version: 2
+
+multi-ecosystem-groups:
+  dependencies:
+    schedule:
+      # Check for updates on the first Sunday of every month, 8PM UTC
+      interval: "cron"
+      cronjob: "0 20 * * sun#1"
+
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    patterns: ["*"]
+    multi-ecosystem-group: "dependencies"
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    patterns: ["*"]
+    multi-ecosystem-group: "dependencies"

.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+  workflow_call:
+
+# Cancel active CI runs for a PR before starting another run
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: bash  # https://github.com/beeware/briefcase/pull/912
+
+env:
+  FORCE_COLOR: "1"
+
+jobs:
+  pre-commit:
+    name: Pre-commit checks
+    uses: beeware/.github/.github/workflows/pre-commit-run.yml@main
+    with:
+      pre-commit-source: "--group pre-commit"

.github/workflows/pre-commit-update.yml

@@ -0,0 +1,18 @@
+name: Update pre-commit
+
+on:
+  schedule:
+    - cron: "0 20 1-7 * */7"  # First Sunday of the month @ 2000 UTC
+      # Reading this expression: At 20:00 on every day-of-month from 1 through 7 if
+      # it's on every 7th day-of-week, i.e. any one of the first seven days of the
+      # month as long as it is a Sunday.
+  workflow_dispatch:
+
+jobs:
+  pre-commit-update:
+    name: Update pre-commit
+    uses: beeware/.github/.github/workflows/pre-commit-update.yml@main
+    secrets: inherit
+    with:
+      pre-commit-source: pre-commit
+      create-changenote: false

.gitignore

@@ -4,3 +4,4 @@ comment.md
 
 .idea
 .tox
+__pycache__

.pre-commit-config.yaml

@@ -9,3 +9,8 @@ repos:
         # PO files may not have a trailing EOL, as they are tool generated
         exclude: "locales"
       - id: trailing-whitespace
+# TODO: Enable for final.
+#  - repo: https://github.com/rvben/rumdl-pre-commit
+#    rev: v0.0.155
+#    hooks:
+#      - id: rumdl

.pyspelling.yml

@@ -5,7 +5,8 @@ matrix:
     - docs/spelling_wordlist
     output: _build/dictionary/python.dic
   sources:
-  - '**/*.md'
+  - 'docs/**/*.md'
+  - README.md
   pipeline:
   - pyspelling.filters.markdown:
       markdown_extensions:

.readthedocs.yaml

@@ -21,4 +21,5 @@ build:
       - python -m tox -e docs-lint
     build:
       html:
-        - python -m tox -e docs-$READTHEDOCS_LANGUAGE -- --output=$READTHEDOCS_OUTPUT/html/
+        # TODO: Remove --build-with-warnings before going live.
+        - python -m tox -e docs-$READTHEDOCS_LANGUAGE -- --build-with-warnings --output=$READTHEDOCS_OUTPUT/html/

docs-redirect/en/README.md

@@ -1 +1 @@
-This file is intentionally blank for the purposes of creating the `en` directory.
+This file is intentionally blank for the purposes of creating the `en` directory.

docs/config.yml

@@ -1,9 +1,64 @@
 # yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
 copyright: © Russell Keith-Magee
 
+nav:
+  - About:
+      - about/index.md
+      - What is BeeWare?: about/overview.md
+      - The Bee Team: about/team.md
+      - History and Philosophy: about/history.md
+      - Contact: about/contact.md
+      - Branding guidelines: about/branding.md
+  - Documentation:
+      - docs/index.md
+  - Community:
+      - community/index.md
+      - BeeWare Community Code of Conduct: community/code-of-conduct.md
+      - Governance: community/governance.md
+  - Contributing:
+      - contributing/index.md
+      - First-time contributors: contributing/first-time-contributors.md
+      - Contribution guide:
+          - contributing/guide/index.md
+          - Fix an issue: contributing/guide/what/fix-issue.md
+          - Implement a new feature: contributing/guide/what/implement-feature.md
+          - Write documentation: contributing/guide/what/write-docs.md
+          - Triage an issue: contributing/guide/what/triage.md
+          - Review a pull request: contributing/guide/what/review-pr.md
+          - Propose a new feature: contributing/guide/what/propose-feature.md
+          - Translate content: contributing/guide/what/translate.md
+          - Use the tools: contributing/guide/what/use-tools.md
+          - Setting up a development environment: contributing/guide/how/dev-environment.md
+          - Reproducing an issue: contributing/guide/how/reproduce-issue.md
+          - Working from a branch: contributing/guide/how/branches.md
+          - Avoiding scope creep: contributing/guide/how/scope-creep.md
+          - Writing, running, and testing code: contributing/guide/how/write-code.md
+          - Building documentation: contributing/guide/how/build-docs.md
+          - Writing documentation: contributing/guide/how/write-docs.md
+          - Adding a change note: contributing/guide/how/change-note.md
+          - Submitting a pull request: contributing/guide/how/submit-pr.md
+          - Providing a review: contributing/guide/how/review-pr.md
+          - Submitting a new issue: contributing/guide/how/new-issue.md
+          - Proposing a new feature: contributing/guide/how/propose-feature.md
+          - Translating content: contributing/guide/how/translate.md
+          - Pull request review process: contributing/guide/next/pr-review.md
+          - Release process: contributing/guide/next/release.md
+          - Code style guide: contributing/guide/style/code-style-guide.md
+          - Documentation style guide: contributing/guide/style/docs-style-guide.md
+      - Sprint guide: contributing/sprint-guide.md
+      - Challenge coins: contributing/challenge-coins.md
+  - News:
+      - news/index.md
+  - Sponsor:
+      - membership/index.md
+
 not_in_nav: |
   /index.md
 
+exclude_docs: |  # This is the only way to keep the build from parsing the team bio files.
+  !.*
+  /about/team/
+
 validation:
   omitted_files: warn
   absolute_links: relative_to_docs
@@ -13,6 +68,13 @@ validation:
 extra:
   project_name: beeware
   formal_name: BeeWare
+  hide_dev_links: true
+  website: true
+  translated: true
+  min_python_version: "3.10"  # The oldest supported Python version
+  min_python_version_tag: "310"  # The tag version of the minimum python version
+  recent_python_version: "3.13"  # The newest Python version known to work on all platforms
+  docs_python_version: "3.13"  # The version of Python required to build the documentation
   social:
     - icon: fontawesome/brands/github
       link: https://github.com/beeware
@@ -23,6 +85,15 @@ extra:
     - icon: fontawesome/brands/discord
       link: https://beeware.org/bee/chat/
       name: BeeWare on Discord
+    - icon: fontawesome/solid/square-rss
+      name: BeeWare blog RSS feed
+      link: https://beeware.org/news/buzz/atom.xml
+  github_icon: <i class="fa-github fa-brands" aria-hidden="true"></i>
+  generator: false
+
+
+extra_css:
+  - stylesheets/beeware.css
 
 theme:
   name: material
@@ -32,10 +103,12 @@ theme:
   features:
     - content.tabs.link
     - toc.follow
-    - navigation.indexes
-    - navigation.footer
     - navigation.tabs
     - navigation.tabs.sticky
+    - navigation.indexes
+    - navigation.sections
+    - navigation.path
+    - navigation.expand
     - search.suggest
     - search.highlight
     - search.share
@@ -66,6 +139,7 @@ markdown_extensions:
   pymdownx.superfences: {}
   pymdownx.blocks.admonition: {}
   pymdownx.blocks.caption: {}
+  pymdownx.details: {}
   pymdownx.blocks.tab:
     alternate_style: true
   pymdownx.snippets:
@@ -76,10 +150,39 @@ markdown_extensions:
     permalink: true
     title: On this page
   attr_list: {}
+  md_in_html: {}
+  admonition: {}  # Enabled for all admonition types EXCEPT note and admonition (which defaults to note)
 
 plugins:
   search: {}
-  autorefs: {}
-  literate-nav:
-    nav_file: SUMMARY.md
-  macros: {}
+  blog:
+    blog_dir: news
+    post_url_format: "{categories}/{slug}"
+    post_url_max_categories: 1
+    categories_url_format: "{slug}"
+    categories_allowed:
+      - Buzz
+      - Events
+      - Resources
+  autorefs:
+    resolve_closest: true  # autorefs warns of the Usage headings begin duplicates without this - we will have to assign unique ids to all of them otherwise
+  macros:
+    module_name: macros
+    include_yaml:
+        - team: en/news/.authors.yml
+
+  meta: {}
+  rss:
+    feed_title: "BeeWare: The Buzz"
+    feed_description: News and events for the BeeWare project.
+    match_path: "news/posts/.*"
+    use_git: false  # Forces it to read the dates from the frontmatter.
+    date_from_meta:
+      as_creation: "date"
+      datetime_format: "%Y-%m-%d"
+    categories:
+      - categories
+    feeds_filenames:
+      rss_created: news/buzz/atom.xml
+#    image: images/brutus.png  # Update to a Brutus URL
+    abstract_chars_count: -1

docs/en/about/.meta.yml

@@ -0,0 +1,2 @@
+hide:
+  - navigation

docs/en/about/branding.md

@@ -0,0 +1,53 @@
+# Branding guidelines
+
+## Referring to the project
+
+This project should be referred to as **The BeeWare Project**, or **BeeWare**.
+
+### Short description
+
+BeeWare is a collection of tools and libraries to aid in writing application user interfaces in Python.
+
+### Long description
+
+BeeWare is a collection of tools and libraries to aid in writing application user interfaces in Python. It enables developers to write applications for iPhone, Android, Linux, macOS and Windows that are indistinguishable from natively written applications.
+
+## Logos
+
+The following images are official logos of the BeeWare project. They are trademarks of the BeeWare Project; they can be used nominatively, but should not be used imply an official association with the project that does not exist. If you have any questions about logo usage, contact [Founding Apiarist Russell Keith-Magee](mailto:russell@beeware.org).
+
+### BeeWare logo
+
+![BeeWare logo](images/beeware-150.png)
+
+- [Small](images/beeware-150.png)
+- [Medium](images/beeware-519.png)
+- [Vector](images/beeware.eps)
+
+### BeeWare logo (wide)
+
+![BeeWare logo (wide)](images/beeware-wide-143.png)
+
+- [Small](images/beeware-wide-143.png)
+- [Medium](images/beeware-wide-600.png)
+- [Large](images/beeware-wide-2028.png)
+- [Vector](images/beeware-wide.eps)
+
+### BeeWare Enthusiasts logo
+
+![BeeWare Enthusiasts logo](images/beeware-enthusiasts-150.png)
+
+- [Small](images/beeware-enthusiasts-150.png)
+- [Medium](images/beeware-enthusiasts-600.png)
+- [Large](images/beeware-enthusiasts-2000.png)
+- [Vector](images/beeware-enthusiasts.eps)
+
+### Brutus the Bee
+
+![Brutus the Bee](images/brutus-128.png)
+
+- [Small](images/brutus-32.png)
+- [Medium](images/brutus-128.png)
+- [Large](images/brutus-256.png)
+- [X-large](images/brutus-1024.png)
+- [Vector](images/brutus.eps)

docs/en/about/contact.md

@@ -0,0 +1,49 @@
+# Contact
+
+## Looking for help?
+
+The [core team](team.md) are always happy to answer questions and provide assistance with BeeWare. Be aware that we work in public, both with BeeWare development and the community. Asking your questions in a public forum ensures that as many people as possible are able to benefit from any answer that is give. The fact is, if you're having a problem, it's highly likely that someone else is too, or certainly will at some point in time.
+
+## Where can you find us?
+You can engage with the BeeWare community in several different ways.
+
+### Discord
+
+We use [Discord](https://beeware.org/bee/chat) for real-time communication. You can introduce yourself in the #introductions channel. The #help-with-beeware channel is available for questions and issues regarding using BeeWare. The #dev channel is available for discussion about BeeWare contributing and development. You can tell us about your BeeWare project in the #showcase channel; works-in-progress and completed projects are all welcome!
+
+### Mastodon
+
+Follow [@beeware@fosstodon.org](https://fosstodon.org/@beeware) on Mastodon for day-to-day updates on the BeeWare project.
+
+### GitHub
+
+A lot of project-specific communication happens on the GitHub Issues for each project. Links for our high-profile projects can be found on our [documentation page](../docs/index.md); visit the [GitHub page for the BeeWare organization](https://github.com/beeware) for the full list of repositories.
+
+We also use GitHub Discussions as a forum to discuss projects. If you have a question about how to use a BeeWare tool, open a discussion thread in the repository for that tool.
+
+### Newsletter
+
+Want to receive updates, hints, tips, and announcements related to BeeWare? [Sign up for the BeeWare Enthusiasts mailing list](https://eepurl.com/b2Xb4z).
+
+## Commercial support
+
+Need help with your commercial BeeWare project?
+
+Although BeeWare is an open source project, there are companies and individuals who can provide paid support, training, and consulting.
+
+Note that the core team will *not* provide free support or debugging help for commercial projects. If you're not able to post your question on a public forum due to the content being commercially sensitive, you'll need to seek out someone willing to provide commercial support to meet for your needs.
+
+Contact <consulting@beeware.org> for any inquiries about these services.
+
+## Reporting security issues
+
+If you want to report a security problem with one of the BeeWare tools, please contact the [Core Team](team.md).
+
+## Reporting Code of Conduct issues
+If you have had an uncomfortable experience in a BeeWare community space, or want to report a behavior problem with someone who is a member of the BeeWare community, the [Core Team](team.md) will be happy to manage your report in accordance with our [Code of Conduct reporting guide](../community/code-of-conduct.md).
+
+## Other enquiries
+
+For all media enquiries, please contact Founding Apiarist [Russell Keith-Magee](mailto:russell@beeware.org) or Senior Apiarist [Philip James](mailto:philip@beeware.org).
+
+For all other enquiries, please contact Founding Apiarist [Russell Keith-Magee](mailto:russell@beeware.org).