SeaCMS/pico
3
0
Fork 0
Code Issues Pull Requests Activity

Update various links

Browse Source
This commit is contained in:
Daniel Rudolf 2022-02-13 15:10:08 +01:00
parent 76a761c3a2
commit e33f6c8148
No known key found for this signature in database
GPG Key ID: A061F02CD8DE4538
10 changed files with 36 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.phpdoc.xml
View File

@ -2,7 +2,7 @@
<phpdocumentor <phpdocumentor
configVersion="3" configVersion="3"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.phpdoc.org" xmlns="https://www.phpdoc.org"
xsi:noNamespaceSchemaLocation="data/xsd/phpdoc.xsd" xsi:noNamespaceSchemaLocation="data/xsd/phpdoc.xsd"
> >
<paths> <paths>

16
CONTRIBUTING.md
View File

@ -19,7 +19,7 @@ Please describe your issue as clear as possible and always include the *Pico ver
Contributing Contributing
------------ ------------
Once you decide you want to contribute to *Pico's core* (which we really appreciate!) you can fork the project from https://github.com/picocms/Pico. If you're interested in developing a *plugin* or *theme* for Pico, please refer to the [development section](http://picocms.org/development/) of our website. Once you decide you want to contribute to *Pico's core* (which we really appreciate!) you can fork the project from https://github.com/picocms/Pico. If you're interested in developing a *plugin* or *theme* for Pico, please refer to the [development section](https://picocms.org/development/) of our website.
### Developer Certificate of Origin ### Developer Certificate of Origin
@ -108,7 +108,7 @@ Please keep in mind that pull requests should be small (i.e. one feature per req
### Coding Standards ### Coding Standards
Pico uses the [PSR-2 Coding Standard](http://www.php-fig.org/psr/psr-2/) as defined by the [PHP Framework Interoperability Group (PHP-FIG)](http://www.php-fig.org/). Pico uses the [PSR-2 Coding Standard](https://www.php-fig.org/psr/psr-2/) as defined by the [PHP Framework Interoperability Group (PHP-FIG)](https://www.php-fig.org/).
For historical reasons we don't use formal namespaces. Markdown files in the `content-sample` folder (the inline documentation) must follow a hard limit of 80 characters line length. For historical reasons we don't use formal namespaces. Markdown files in the `content-sample` folder (the inline documentation) must follow a hard limit of 80 characters line length.
@ -122,18 +122,18 @@ With this command you can specify a file or folder to limit which files it will
Pico accepts the problems of having redundant documentation on different places (concretely Pico's inline user docs, the `README.md` and the website) for the sake of a better user experience. When updating the docs, please make sure to keep them in sync. Pico accepts the problems of having redundant documentation on different places (concretely Pico's inline user docs, the `README.md` and the website) for the sake of a better user experience. When updating the docs, please make sure to keep them in sync.
If you update the [`README.md`](https://github.com/picocms/Pico/blob/master/README.md) or [`content-sample/index.md`](https://github.com/picocms/Pico/blob/master/content-sample/index.md), please make sure to update the corresponding files in the [`_docs`](https://github.com/picocms/picocms.github.io/tree/master/_docs/) folder of the `picocms.github.io` repo (i.e. [Pico's website](http://picocms.org/docs/)) and vice versa. Unfortunately this involves three (!) different markdown parsers. If you're experiencing problems, use Pico's [`erusev/parsedown-extra`](https://github.com/erusev/parsedown-extra) as a reference. You can try to make the contents compatible to [Kramdown](http://kramdown.gettalong.org/) (Pico's website) and [CommonMarker](https://github.com/gjtorikian/commonmarker) (`README.md`) by yourself, otherwise please address the issues in your pull request message and we'll take care of it. If you update the [`README.md`](https://github.com/picocms/Pico/blob/master/README.md) or [`content-sample/index.md`](https://github.com/picocms/Pico/blob/master/content-sample/index.md), please make sure to update the corresponding files in the [`_docs`](https://github.com/picocms/picocms.github.io/tree/master/_docs/) folder of the `picocms.github.io` repo (i.e. [Pico's website](https://picocms.org/docs/)) and vice versa. Unfortunately this involves three (!) different markdown parsers. If you're experiencing problems, use Pico's [`erusev/parsedown-extra`](https://github.com/erusev/parsedown-extra) as a reference. You can try to make the contents compatible to [Kramdown](https://kramdown.gettalong.org/) (Pico's website) and [CommonMarker](https://github.com/gjtorikian/commonmarker) (`README.md`) by yourself, otherwise please address the issues in your pull request message and we'll take care of it.
Versioning Versioning
---------- ----------
Pico follows [Semantic Versioning 2.0](http://semver.org) and uses version numbers like `MAJOR`.`MINOR`.`PATCH`. We will increment the: Pico follows [Semantic Versioning 2.0](https://semver.org) and uses version numbers like `MAJOR`.`MINOR`.`PATCH`. We will increment the:
- `MAJOR` version when we make incompatible API changes, - `MAJOR` version when we make incompatible API changes,
- `MINOR` version when we add functionality in a backwards-compatible manner, and - `MINOR` version when we add functionality in a backwards-compatible manner, and
- `PATCH` version when we make backwards-compatible bug fixes. - `PATCH` version when we make backwards-compatible bug fixes.
For more information please refer to the http://semver.org website. For more information please refer to the https://semver.org website.
Branching Branching
--------- ---------
@ -153,7 +153,7 @@ As soon as development reaches a point where feedback is appreciated, a pull req
Build & Release process Build & Release process
----------------------- -----------------------
We're using [Travis CI](https://travis-ci.com) to automate the build & release process of Pico. It generates and deploys a [PHP class documentation](http://picocms.org/phpDoc/) (powered by [phpDoc](http://phpdoc.org)) for new releases and on every commit to the `master` branch. Travis also prepares new releases by generating Pico's pre-built release packages, a version badge, code statistics (powered by [cloc](https://github.com/AlDanial/cloc)) and updates our website (the [`picocms.github.io` repo](https://github.com/picocms/picocms.github.io)). Please refer to our [`.travis.yml`](https://github.com/picocms/Pico/blob/master/.travis.yml), the [`picocms/ci-tools` repo](https://github.com/picocms/ci-tools) and the [`.build` directory](https://github.com/picocms/Pico/tree/master/.build) for details. We're using [Travis CI](https://travis-ci.com) to automate the build & release process of Pico. It generates and deploys a [PHP class documentation](https://picocms.org/phpDoc/) (powered by [phpDoc](https://phpdoc.org)) for new releases and on every commit to the `master` branch. Travis also prepares new releases by generating Pico's pre-built release packages, a version badge, code statistics (powered by [cloc](https://github.com/AlDanial/cloc)) and updates our website (the [`picocms.github.io` repo](https://github.com/picocms/picocms.github.io)). Please refer to our [`.travis.yml`](https://github.com/picocms/Pico/blob/master/.travis.yml), the [`picocms/ci-tools` repo](https://github.com/picocms/ci-tools) and the [`.build` directory](https://github.com/picocms/Pico/tree/master/.build) for details.
As insinuated above, it is important that each commit to `master` is deployable. Once development of a new Pico release is finished, trigger Pico's build & release process by pushing a new Git tag. This tag should reference a (usually empty) commit on `master`, which message should adhere to the following template: As insinuated above, it is important that each commit to `master` is deployable. Once development of a new Pico release is finished, trigger Pico's build & release process by pushing a new Git tag. This tag should reference a (usually empty) commit on `master`, which message should adhere to the following template:
@ -171,7 +171,7 @@ Before pushing a new Git tag, make sure to update the `Pico::VERSION` and `Pico:
If you're pushing a new major or minor release of Pico, you should also update Pico's `composer.json` to require the latest minor releases of Pico's dependencies. Besides, don't forget to update the `@version` tags in the PHP class docs. If you're pushing a new major or minor release of Pico, you should also update Pico's `composer.json` to require the latest minor releases of Pico's dependencies. Besides, don't forget to update the `@version` tags in the PHP class docs.
Travis CI will draft the new [release on GitHub](https://github.com/picocms/Pico/releases) automatically, but will require you to manually amend the descriptions formatting. The latest Pico version is always available at https://github.com/picocms/Pico/releases/latest, so please make sure to publish this URL rather than version-specific URLs. [Packagist](http://packagist.org/packages/picocms/pico) will be updated automatically. Travis CI will draft the new [release on GitHub](https://github.com/picocms/Pico/releases) automatically, but will require you to manually amend the descriptions formatting. The latest Pico version is always available at https://github.com/picocms/Pico/releases/latest, so please make sure to publish this URL rather than version-specific URLs. [Packagist](https://packagist.org/packages/picocms/pico) will be updated automatically.
Labeling of Issues & Pull Requests Labeling of Issues & Pull Requests
---------------------------------- ----------------------------------
@ -206,4 +206,4 @@ Issues and pull requests labeled with `info: Information Needed` indicate that w
Issues and pull requests, which are rather related to upstream projects (i.e. projects Pico depends on, like Twig), are additionally labeled with `info: Upstream`. Issues and pull requests, which are rather related to upstream projects (i.e. projects Pico depends on, like Twig), are additionally labeled with `info: Upstream`.
When a issue or pull request isn't directly related to Pico's core, but the project as a whole, it is labeled with `info: Meta`. Issues labeled with `info: Website` are related to [Pico's website](http://picocms.org), however, in this case it is usually expedient to move the issue to the [`picocms.github.io` repo](https://github.com/picocms/picocms.github.io) instead. The same applies to the `info: Pico CMS for Nextcloud` label; these issues are related to [Pico CMS for Nextcloud](https://apps.nextcloud.com/apps/cms_pico). When a issue or pull request isn't directly related to Pico's core, but the project as a whole, it is labeled with `info: Meta`. Issues labeled with `info: Website` are related to [Pico's website](https://picocms.org), however, in this case it is usually expedient to move the issue to the [`picocms.github.io` repo](https://github.com/picocms/picocms.github.io) instead. The same applies to the `info: Pico CMS for Nextcloud` label; these issues are related to [Pico CMS for Nextcloud](https://apps.nextcloud.com/apps/cms_pico).

20
README.md
View File

@ -9,7 +9,7 @@ Pico
Pico is a stupidly simple, blazing fast, flat file CMS. Pico is a stupidly simple, blazing fast, flat file CMS.
Visit us at http://picocms.org/ and see http://picocms.org/about/ for more info. Visit us at https://picocms.org/ and see https://picocms.org/about/ for more info.
Screenshot Screenshot
---------- ----------
@ -198,7 +198,7 @@ Contributing
You want to contribute to Pico? We really appreciate that! You can help make Pico better by [contributing code][PullRequests] or [reporting issues][Issues], but please take note of our [contribution guidelines][ContributionGuidelines]. In general you can contribute in three different areas: You want to contribute to Pico? We really appreciate that! You can help make Pico better by [contributing code][PullRequests] or [reporting issues][Issues], but please take note of our [contribution guidelines][ContributionGuidelines]. In general you can contribute in three different areas:
1. Plugins & Themes: You're a plugin developer or theme designer? We love you folks! You can find tons of information about how to develop plugins and themes at http://picocms.org/development/. If you have created a plugin or theme, please add it to our [Wiki][], either on the [plugins][WikiPlugins] or [themes][WikiThemes] page. You may also [Submit][] it to our website, where it'll be displayed on the official [plugin][OfficialPlugins] or [theme][OfficialThemes] pages! 1. Plugins & Themes: You're a plugin developer or theme designer? We love you folks! You can find tons of information about how to develop plugins and themes at https://picocms.org/development/. If you have created a plugin or theme, please add it to our [Wiki][], either on the [plugins][WikiPlugins] or [themes][WikiThemes] page. You may also [Submit][] it to our website, where it'll be displayed on the official [plugin][OfficialPlugins] or [theme][OfficialThemes] pages!
2. Documentation: We always appreciate people improving our documentation. You can either improve the [inline user docs][EditInlineDocs] or the more extensive [user docs on our website][EditUserDocs]. You can also improve the [docs for plugin and theme developers][EditDevDocs]. Simply fork our website's Git repository from https://github.com/picocms/picocms.github.io, change the Markdown files and open a [pull request][PullRequestsWebsite]. 2. Documentation: We always appreciate people improving our documentation. You can either improve the [inline user docs][EditInlineDocs] or the more extensive [user docs on our website][EditUserDocs]. You can also improve the [docs for plugin and theme developers][EditDevDocs]. Simply fork our website's Git repository from https://github.com/picocms/picocms.github.io, change the Markdown files and open a [pull request][PullRequestsWebsite].
@ -232,21 +232,21 @@ Official Pico Contributors won't claim bounties on their own behalf, Pico will n
[PicoThemePackagist]: https://packagist.org/packages/picocms/pico-theme [PicoThemePackagist]: https://packagist.org/packages/picocms/pico-theme
[PicoDeprecatedPackagist]: https://packagist.org/packages/picocms/pico-deprecated [PicoDeprecatedPackagist]: https://packagist.org/packages/picocms/pico-deprecated
[PicoComposerPackagist]: https://packagist.org/packages/picocms/pico-composer [PicoComposerPackagist]: https://packagist.org/packages/picocms/pico-composer
[SemVer]: http://semver.org [SemVer]: https://semver.org
[HelpFork]: https://help.github.com/en/github/getting-started-with-github/fork-a-repo [HelpFork]: https://help.github.com/en/github/getting-started-with-github/fork-a-repo
[HelpUpgrade]: http://picocms.org/in-depth/upgrade/ [HelpUpgrade]: https://picocms.org/in-depth/upgrade/
[HelpUserDocs]: http://picocms.org/docs/ [HelpUserDocs]: https://picocms.org/docs/
[HelpDevDocs]: http://picocms.org/development/ [HelpDevDocs]: https://picocms.org/development/
[Submit]: http://picocms.org/in-depth/submission_guidelines [Submit]: https://picocms.org/in-depth/submission_guidelines
[OfficialPlugins]: http://picocms.org/plugins/ [OfficialPlugins]: https://picocms.org/plugins/
[OfficialThemes]: http://picocms.org/themes/ [OfficialThemes]: https://picocms.org/themes/
[Wiki]: https://github.com/picocms/Pico/wiki [Wiki]: https://github.com/picocms/Pico/wiki
[WikiPlugins]: https://github.com/picocms/Pico/wiki/Pico-Plugins [WikiPlugins]: https://github.com/picocms/Pico/wiki/Pico-Plugins
[WikiThemes]: https://github.com/picocms/Pico/wiki/Pico-Themes [WikiThemes]: https://github.com/picocms/Pico/wiki/Pico-Themes
[Issues]: https://github.com/picocms/Pico/issues [Issues]: https://github.com/picocms/Pico/issues
[IssuesSearch]: https://github.com/picocms/Pico/search?type=Issues [IssuesSearch]: https://github.com/picocms/Pico/search?type=Issues
[LiberaChat]: https://web.libera.chat/#picocms [LiberaChat]: https://web.libera.chat/#picocms
[LiberaChatLogs]: http://picocms.org/irc-logs [LiberaChatLogs]: https://picocms.org/irc-logs
[PullRequests]: https://github.com/picocms/Pico/pulls [PullRequests]: https://github.com/picocms/Pico/pulls
[PullRequestsWebsite]: https://github.com/picocms/picocms.github.io/pulls [PullRequestsWebsite]: https://github.com/picocms/picocms.github.io/pulls
[ContributionGuidelines]: https://github.com/picocms/Pico/blob/master/CONTRIBUTING.md [ContributionGuidelines]: https://github.com/picocms/Pico/blob/master/CONTRIBUTING.md

6
composer.json
View File

@ -3,7 +3,7 @@
"type": "library", "type": "library",
"description": "Pico is a flat file CMS, this means there is no administration backend and database to deal with. You simply create .md files in the \"content\" folder and that becomes a page.", "description": "Pico is a flat file CMS, this means there is no administration backend and database to deal with. You simply create .md files in the \"content\" folder and that becomes a page.",
"keywords": ["pico", "picocms", "pico-cms", "simple", "flat-file", "cms", "content-management", "website", "markdown-to-html", "php", "markdown", "yaml", "twig" ], "keywords": ["pico", "picocms", "pico-cms", "simple", "flat-file", "cms", "content-management", "website", "markdown-to-html", "php", "markdown", "yaml", "twig" ],
"homepage": "http://picocms.org/", "homepage": "https://picocms.org/",
"license": "MIT", "license": "MIT",
"authors": [ "authors": [
{ {
@ -18,7 +18,7 @@
}, },
{ {
"name": "The Pico Community", "name": "The Pico Community",
"homepage": "http://picocms.org/" "homepage": "https://picocms.org/"
}, },
{ {
"name": "Contributors", "name": "Contributors",
@ -26,7 +26,7 @@
} }
], ],
"support": { "support": {
"docs": "http://picocms.org/docs", "docs": "https://picocms.org/docs",
"issues": "https://github.com/picocms/Pico/issues", "issues": "https://github.com/picocms/Pico/issues",
"source": "https://github.com/picocms/Pico" "source": "https://github.com/picocms/Pico"
}, },

4
content-sample/index.md
View File

@ -360,7 +360,7 @@ even easier.
#### Plugins for users #### Plugins for users
Officially tested plugins can be found at http://picocms.org/plugins/, but Officially tested plugins can be found at https://picocms.org/plugins/, but
there are many awesome third-party plugins out there! A good start point for there are many awesome third-party plugins out there! A good start point for
discovery is [our Wiki][WikiPlugins]. discovery is [our Wiki][WikiPlugins].
@ -385,7 +385,7 @@ disabled through your `config/config.yml`. If you want to e.g. disable the
#### Plugins for developers #### Plugins for developers
You're a plugin developer? We love you guys! You can find tons of information You're a plugin developer? We love you guys! You can find tons of information
about how to develop plugins at http://picocms.org/development/. If you've about how to develop plugins at https://picocms.org/development/. If you've
developed a plugin before and want to upgrade it to Pico 2.0, refer to the developed a plugin before and want to upgrade it to Pico 2.0, refer to the
[upgrade section of the docs][PluginUpgrade]. [upgrade section of the docs][PluginUpgrade].

4
lib/AbstractPicoPlugin.php
View File

@ -19,8 +19,8 @@
* @see PicoPluginInterface * @see PicoPluginInterface
* *
* @author Daniel Rudolf * @author Daniel Rudolf
* @link http://picocms.org * @link https://picocms.org
* @license http://opensource.org/licenses/MIT The MIT License * @license https://opensource.org/licenses/MIT The MIT License
* @version 3.0 * @version 3.0
*/ */
abstract class AbstractPicoPlugin implements PicoPluginInterface abstract class AbstractPicoPlugin implements PicoPluginInterface

8
lib/Pico.php
View File

@ -41,12 +41,12 @@ use Twig\TwigFilter;
* - Open Source: Pico is completely free and open source, * - Open Source: Pico is completely free and open source,
* released under the MIT license. * released under the MIT license.
* *
* See <http://picocms.org/> for more info. * See <https://picocms.org/> for more info.
* *
* @author Gilbert Pellegrom * @author Gilbert Pellegrom
* @author Daniel Rudolf * @author Daniel Rudolf
* @link http://picocms.org * @link https://picocms.org
* @license http://opensource.org/licenses/MIT The MIT License * @license https://opensource.org/licenses/MIT The MIT License
* @version 3.0 * @version 3.0
*/ */
class Pico class Pico
@ -2121,7 +2121,7 @@ class Pico
* {@see PicoTwigExtension} Twig extension. * {@see PicoTwigExtension} Twig extension.
* *
* @see Pico::getTwig() * @see Pico::getTwig()
* @see http://twig.sensiolabs.org/ Twig website * @see https://twig.symfony.com/ Twig website
* @see https://github.com/twigphp/Twig Twig on GitHub * @see https://github.com/twigphp/Twig Twig on GitHub
* *
* @return TwigEnvironment|null Twig template engine * @return TwigEnvironment|null Twig template engine

4
lib/PicoPluginInterface.php
View File

@ -24,8 +24,8 @@
* to update your plugin to use Pico's latest API version. * to update your plugin to use Pico's latest API version.
* *
* @author Daniel Rudolf * @author Daniel Rudolf
* @link http://picocms.org * @link https://picocms.org
* @license http://opensource.org/licenses/MIT The MIT License * @license https://opensource.org/licenses/MIT The MIT License
* @version 3.0 * @version 3.0
*/ */
interface PicoPluginInterface interface PicoPluginInterface

4
lib/PicoTwigExtension.php
View File

@ -20,8 +20,8 @@ use Twig\TwigFunction;
* Pico's Twig extension to implement additional filters * Pico's Twig extension to implement additional filters
* *
* @author Daniel Rudolf * @author Daniel Rudolf
* @link http://picocms.org * @link https://picocms.org
* @license http://opensource.org/licenses/MIT The MIT License * @license https://opensource.org/licenses/MIT The MIT License
* @version 3.0 * @version 3.0
*/ */
class PicoTwigExtension extends AbstractTwigExtension class PicoTwigExtension extends AbstractTwigExtension

4
plugins/DummyPlugin.php
View File

@ -21,8 +21,8 @@ use Twig\Environment as TwigEnvironment;
* Simply remove the events you don't need and add your own logic. * Simply remove the events you don't need and add your own logic.
* *
* @author Daniel Rudolf * @author Daniel Rudolf
* @link http://picocms.org * @link https://picocms.org
* @license http://opensource.org/licenses/MIT The MIT License * @license https://opensource.org/licenses/MIT The MIT License
* @version 3.0 * @version 3.0
*/ */
class DummyPlugin extends AbstractPicoPlugin class DummyPlugin extends AbstractPicoPlugin