Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docu and files for the upcoming release #55

Merged
merged 5 commits into from
Aug 7, 2020
Merged

Update docu and files for the upcoming release #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4416019
Update extension.json
kghbln Aug 7, 2020
fefd56f
Update README.md
kghbln Aug 7, 2020
4720328
Update composer.json
kghbln Aug 7, 2020
369a344
Update INSTALL.md
kghbln Aug 7, 2020
c2a73ee
Update RELEASE-NOTES.md
kghbln Aug 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This extension provides the `#mermaid` parser function to support the generation

## Requirements

- PHP 5.6 or later
- PHP 7.0 or later
- MediaWiki 1.33 or later

## Installation and configuration
Expand Down
6 changes: 3 additions & 3 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "mediawiki/mermaid",
"type": "mediawiki-extension",
"description": "Provides a parser function to generate diagrams and flowcharts with the help of the mermaid script language",
"description": "Provides a parser function to generate diagrams and charts with the help of the mermaid script language",
"keywords": [
"mediawiki",
"mermaid",
Expand All @@ -20,12 +20,12 @@
}
],
"require": {
"php": ">=5.6.0",
"php": ">=7.0.0",
"composer/installers": "1.*,>=1.0.1"
},
"extra": {
"branch-alias": {
"dev-master": "2.x-dev"
"dev-master": "3.x-dev"
}
},
"autoload": {
Expand Down
18 changes: 8 additions & 10 deletions docs/INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This file contains the *installation and configuration instructions* for the **Mermaid** extension. See also the
[readme], the [release notes] and [usage examples].
This file contains the *installation and configuration instructions* for the **Mermaid** extension.
See also the [readme], the [release notes] and [usage examples].

## Installation

Expand All @@ -13,15 +13,15 @@ If you do not have a "composer.local.json" file yet, create one and add the foll
```
{
"require": {
"mediawiki/mermaid": "~2.3"
"mediawiki/mermaid": "~3.0"
}
}
```

If you already have a "composer.local.json" file add the following line to the end of the "require"
section in your file:

"mediawiki/mermaid": "~2.3"
"mediawiki/mermaid": "~3.0"

Remember to add a comma to the end of the preceding line in this section.

Expand All @@ -31,9 +31,6 @@ Run the following command in your shell:

php composer.phar update --no-dev

Note if you have Git installed on your system add the `--prefer-source` flag to the above command. Also
note that it may be necessary to run this command twice. If unsure do it twice right away.

### Step 3

Add the following line to the end of your "LocalSettings.php" file:
Expand All @@ -43,8 +40,8 @@ Add the following line to the end of your "LocalSettings.php" file:

## Configuration

One configuration parameter is provided allowing to choose the basic theme for rendereing the graphs, diagrams
and charts. By default the rendering is set to use the `forest` theme:
One configuration parameter is provided allowing to choose the basic theme for rendering diagrams and charts.
By default the rendering is set to use the `forest` theme:

$mermaidgDefaultTheme = 'forest';

Expand All @@ -61,7 +58,8 @@ In order to update this repo for future updates, clone this repo and run
yarn install

This will pull from the upstream repo and patch the dist js file to load for the mediawiki extension.
Commit any changes and PR back to this repo to put back into the composer packages.
Commit any changes and create a pull request back to the Mermaid extension's repo to put back into the
composer packages.

[readme]: https://github.com/SemanticMediaWiki/Mermaid/blob/master/README.md
[release notes]: https://github.com/SemanticMediaWiki/Mermaid/blob/master/docs/RELEASE-NOTES.md
Expand Down
15 changes: 8 additions & 7 deletions docs/RELEASE-NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
This file contains the *release notes* of the **Mermaid** extension. See also the
[readme], the [installation and configuration information] and [usage examples].

### 2.3.0
### 3.0.0

Released xxx xx, 2020
Released xxx xx, 2020.

* Updates to using 8.5.0
* Refactors the repo to use new Extension.json schema
* Adds support for all configuration options
* Enables direct future upstream updates from main Mermaid repo
* Removes compatibility for MediaWiki 1.32 and earlier
* Removes compatibility for PHP 5.6
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

much easier to understand if you specify the new requirements or the delta

like:

changed min php from PHP 5.6 to PHP 7.0

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

noted this suggestion for the release #48

* Updates to using version 8.5.0 of the mermaid script language
* Adds support for all configuration options provided by the mermaid script language
* Refactors the repository to use the new extension registrion mechanism ("extension.json" schema)
* Enables direct future upstream updates from main MermaidJS code repository

### 2.2.0

Expand All @@ -27,7 +29,6 @@ Released on May 20, 2019.

Released on March 5, 2019.

* Drops support for MediaWiki 1.32 and earlier
* Removes deprecated `mediawiki.api.parse` alias

### 2.0.0
Expand Down
2 changes: 1 addition & 1 deletion extension.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "Mermaid",
"version": "2.3.0-alpha",
"version": "3.0.0-alpha",
"author": [
"James Hong Kong",
"Tyler Gibson"
Expand Down