From 376d749f1abef6c0151d895347b6665bc9b37dfa Mon Sep 17 00:00:00 2001 From: dmunoz Date: Fri, 28 Jun 2024 20:18:34 +0200 Subject: [PATCH 1/3] update mkdocs to latest version --- mkdocs.yml | 5 +++-- mkdocs_requirements.txt | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 07999b2e2e..655dc82aee 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,11 +1,11 @@ site_name: WireCloud site_description: WireCloud Documentation +site_url: https://wirecloud.readthedocs.io/ repo_url: https://github.com/Wirecloud/wirecloud theme: readthedocs extra_css: ['https://www.fiware.org/style/fiware_readthedocs.css', 'https://www.fiware.org/style/fiware_readthedocs_processing.css'] -google_analytics: ['UA-84269043-1', 'wirecloud.readthedocs.io'] -pages: +nav: - 'Introduction': 'index.md' - 'Installation Guide': 'installation_guide.md' - 'Administration Guide': 'administration_guide.md' @@ -25,6 +25,7 @@ pages: - 'Platform Development': - 'Creating themes': 'development/platform/themes.md' - 'Contributing': 'CONTRIBUTING.md' + - 'Code of Conduct': 'CODE_OF_CONDUCT.md' - 'Testing': 'development/platform/testing.md' - 'Translations': 'development/platform/translation.md' - 'Appendix: Widgets': 'widgets.md' diff --git a/mkdocs_requirements.txt b/mkdocs_requirements.txt index 115762bac6..033fb389bd 100644 --- a/mkdocs_requirements.txt +++ b/mkdocs_requirements.txt @@ -1,3 +1,3 @@ -mkdocs==1.1 +mkdocs==1.6 pymdown-extensions -mkdocs-exclude +mkdocs-exclude \ No newline at end of file From d2c84a53c55011f6853f4fc2dcc56c41ace590df Mon Sep 17 00:00:00 2001 From: dmunoz Date: Fri, 28 Jun 2024 20:19:01 +0200 Subject: [PATCH 2/3] fix broken docs links --- CODE_OF_CONDUCT.md | 102 +--------------------------- docs/CODE_OF_CONDUCT.md | 101 +++++++++++++++++++++++++++ docs/CONTRIBUTING.md | 4 +- docs/development/platform/themes.md | 12 ++-- docs/installation_guide.md | 2 +- docs/widgetapi/widgetapi.md | 2 +- 6 files changed, 110 insertions(+), 113 deletions(-) mode change 100644 => 120000 CODE_OF_CONDUCT.md create mode 100644 docs/CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index 71823df2af..0000000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,101 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for -everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity -and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, -or sexual identity and orientation. - -We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. - -## Our Standards - -Examples of behavior that contributes to a positive environment for our community include: - -- Demonstrating empathy and kindness toward other people -- Being respectful of differing opinions, viewpoints, and experiences -- Giving and gracefully accepting constructive feedback -- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -- Focusing on what is best not just for us as individuals, but for the overall community - -Examples of unacceptable behavior include: - -- The use of sexualized language or imagery, and sexual attention or advances of any kind -- Trolling, insulting or derogatory comments, and personal or political attacks -- Public or private harassment -- Publishing others' private information, such as a physical or email address, without their explicit permission -- Other conduct which could reasonably be considered inappropriate in a professional setting - -## Enforcement Responsibilities - -Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take -appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, -or harmful. - -Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, -issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for -moderation decisions when appropriate. - -## Scope - -This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing -the community in public spaces. Examples of representing our community include using an official e-mail address, posting -via an official social media account, or acting as an appointed representative at an online or offline event. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible -for enforcement. All complaints will be reviewed and investigated promptly and fairly. - -All community leaders are obligated to respect the privacy and security of the reporter of any incident. - -## Enforcement Guidelines - -Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem -in violation of this Code of Conduct: - -### 1. Correction - -**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the -community. - -**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation -and an explanation of why the behavior was inappropriate. A public apology may be requested. - -### 2. Warning - -**Community Impact**: A violation through a single incident or series of actions. - -**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including -unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding -interactions in community spaces as well as external channels like social media. Violating these terms may lead to a -temporary or permanent ban. - -### 3. Temporary Ban - -**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. - -**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified -period of time. No public or private interaction with the people involved, including unsolicited interaction with those -enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. - -### 4. Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate -behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. - -**Consequence**: A permanent ban from any sort of public interaction within the community. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at -https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. - -Community Impact Guidelines were inspired by -[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. -Translations are available at https://www.contributor-covenant.org/translations. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 120000 index 0000000000..3d7a75f923 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1 @@ +docs/CODE_OF_CONDUCT.md \ No newline at end of file diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..71823df2af --- /dev/null +++ b/docs/CODE_OF_CONDUCT.md @@ -0,0 +1,101 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for +everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity +and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, +or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our community include: + +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience +- Focusing on what is best not just for us as individuals, but for the overall community + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery, and sexual attention or advances of any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take +appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, +issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for +moderation decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing +the community in public spaces. Examples of representing our community include using an official e-mail address, posting +via an official social media account, or acting as an appointed representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible +for enforcement. All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem +in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the +community. + +**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation +and an explanation of why the behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of actions. + +**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including +unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding +interactions in community spaces as well as external channels like social media. Violating these terms may lead to a +temporary or permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified +period of time. No public or private interaction with the people involved, including unsolicited interaction with those +enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate +behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. +Translations are available at https://www.contributor-covenant.org/translations. diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index ba0e852c15..5002bbac47 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -11,14 +11,14 @@ features. **Contents** -- [Ground rules & expectations](#ground-rules--expectations) +- [Ground rules & expectations](#ground-rules-expectations) - [Using the issue tracker](#using-the-issue-tracker) - [Bug reports](#bug-reports) - [Feature requests](#feature-requests) - [Contributing code](#contributing-code) - [Code Guidelines](#code-guidelines) - [Code style git hooks](#code-style-git-hooks) -- [Community](#Community) +- [Community](#community) ## Ground rules & expectations diff --git a/docs/development/platform/themes.md b/docs/development/platform/themes.md index 46c3926b93..ac58fcd23d 100644 --- a/docs/development/platform/themes.md +++ b/docs/development/platform/themes.md @@ -70,7 +70,7 @@ There are two options for using your themes: you can simply drop the theme folder inside your WireCloud instance folder. Then you can configure your WireCloud instance for using your theme by editing the `settings.py` file and modifying the [`THEME_ACTIVE` - setting](../../installation_guide/#theme_active). + setting](../../installation_guide.md/#theme_active). For example, if you created your WireCloud instance at `/opt/wirecloud_instance`, the `mytheme` folder should be placed at @@ -79,9 +79,9 @@ There are two options for using your themes: your custom theme. 2. You can package and distribute your theme using the standard tools used in - python for that purpose, e.g. using [setuptools] for building your packages - and [[pypi]](the official repository for distributing software for the Python - programming language) for distributing your theme. + python for that purpose, e.g. using [setuptools](https://setuptools.pypa.io) for building your packages + and [the official repository for distributing software for the Python + programming language](https://pypi.python.org/pypi) for distributing your theme. Once installed the theme package into the system, virtual env, ... used by the WireCloud instance, you will be able to use it through the `THEME_ACTIVE` @@ -90,10 +90,6 @@ There are two options for using your themes: > Take into account that in this case you should provide a good module name > for your theme to avoid any clash with other python modules. -[setuptools]: http://pythonhosted.org/setuptools/ -[pypi]: https://pypi.python.org/pypi - - ## Full theme structure and background details Themes in WireCloud are Django applications as well as python modules (that is diff --git a/docs/installation_guide.md b/docs/installation_guide.md index e11fbf47f4..ef35a269e2 100644 --- a/docs/installation_guide.md +++ b/docs/installation_guide.md @@ -776,7 +776,7 @@ The email address that error messages come from, such as those sent to `ADMINS`. A string representing the module that will be use for theming WireCloud. Current themes shipped with WireCloud are `wirecloud.defaulttheme`, `wirecloud.fiwaretheme` and `wirecloud.fiwarelabtheme`. You can also use -[custom themes](development/platform/themes). +[custom themes](development/platform/themes.md). > **NOTE**: `wirecloud.fiwarelabtheme` was previously (WireCloud 0.8.1-) known as `wirecloud.oiltheme`. Although you can > still reference it as `wirecloud.oiltheme` is recommended to switch to the new name: `wirecloud.fiwarelabtheme`. diff --git a/docs/widgetapi/widgetapi.md b/docs/widgetapi/widgetapi.md index 7138fd2506..dfed96651d 100644 --- a/docs/widgetapi/widgetapi.md +++ b/docs/widgetapi/widgetapi.md @@ -824,7 +824,7 @@ MashupPlatform.widget.log(msg, level); - `msg` (_required, string_): is the text of the message to log. - `level` (_optional, default: `MashupPlatform.log.ERROR`_): This optional parameter specifies the level to use for - logging the message. See [MashupPlatform.log](#mashupplatform-log) for available log levels. + logging the message. See [MashupPlatform.log](#mashupplatformlog) for available log levels. **Example usage:** From 04018f9f49160f3350a05b2daca71264593323cc Mon Sep 17 00:00:00 2001 From: dmunoz Date: Fri, 28 Jun 2024 20:19:22 +0200 Subject: [PATCH 3/3] add .readthedocs.yaml to specify build settings --- .readthedocs.yaml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000000..c3def44785 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,19 @@ +# Read the Docs configuration file for MkDocs projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python for docs +build: + os: ubuntu-24.04 + tools: + python: "3.12" + +mkdocs: + configuration: mkdocs.yml + +# Set the build requirements for docs +python: + install: + - requirements: mkdocs_requirements.txt \ No newline at end of file