Browse Source

Updated the documentation

tags/v0.3.0
Cédric Belin 8 months ago
parent
commit
63e65454c5
9 changed files with 35 additions and 33 deletions
  1. +1
    -1
      AUTHORS.txt
  2. +6
    -4
      CHANGELOG.md
  3. +1
    -1
      LICENSE.md
  4. +7
    -7
      README.md
  5. +8
    -8
      doc/about/see_also.md
  6. +2
    -2
      doc/index.md
  7. +1
    -1
      doc/installation.md
  8. +7
    -7
      doc/mkdocs.yaml
  9. +2
    -2
      test/index.php

+ 1
- 1
AUTHORS.txt View File

@@ -1 +1 @@
Cédric Belin <cedric.belin@canalsab.com>
Cédric Belin <cedric@belin.io>

+ 6
- 4
CHANGELOG.md View File

@@ -1,20 +1,22 @@
# Changelog

## Version [0.3.0](https://github.com/sab-international/yii2-gitea/compare/v0.2.0...v0.3.0)
## Version [0.3.0](https://github.com/cedx/yii2-gitea/compare/v0.2.0...v0.3.0)
- Breaking change: raised the required [PHP](https://www.php.net) version.
- Breaking change: removed `__toString()` methods from the model classes.
- Breaking change: using camelcase instead of all caps for constants.
- Breaking change: using PHP 7.4 features, like arrow functions and typed properties.
- Modified the package layout.
- Updated the package dependencies.

## Version [0.2.0](https://github.com/sab-international/yii2-gitea/compare/v0.1.1...v0.2.0)
## Version [0.2.0](https://github.com/cedx/yii2-gitea/compare/v0.1.1...v0.2.0)
- Breaking change: changed the signature of the `fromJson()` methods.
- Added `__toString()` methods to the model classes.
- Added the `TrackedTime` model.
- Added a user guide based on [MkDocs](http://www.mkdocs.org).
- Updated the package dependencies.

## Version [0.1.1](https://github.com/sab-international/yii2-gitea/compare/v0.1.0...v0.1.1)
- Fixed [issue #1](https://github.com/sab-international/yii2-gitea/issues/1): the `Repository::$sshUrl` property should be writable.
## Version [0.1.1](https://github.com/cedx/yii2-gitea/compare/v0.1.0...v0.1.1)
- Fixed [issue #1](https://github.com/cedx/yii2-gitea/issues/1): the `Repository::$sshUrl` property should be writable.

## Version 0.1.0
- Initial release.

+ 1
- 1
LICENSE.md View File

@@ -1,5 +1,5 @@
# MIT License
Copyright &copy; 2018 - 2019 SAB International
Copyright &copy; 2018 - 2020 Cédric Belin

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal


+ 7
- 7
README.md View File

@@ -1,16 +1,16 @@
# Gitea for Yii
![PHP](https://img.shields.io/packagist/php-v/sab-international/yii2-gitea.svg) ![Yii Framework](https://img.shields.io/badge/yii-%3E%3D2.0-brightgreen.svg) ![Release](https://img.shields.io/packagist/v/sab-international/yii2-gitea.svg) ![License](https://img.shields.io/packagist/l/sab-international/yii2-gitea.svg) ![Downloads](https://img.shields.io/packagist/dt/sab-international/yii2-gitea.svg) ![Coverage](https://coveralls.io/repos/github/sab-international/yii2-gitea/badge.svg) ![Build](https://travis-ci.com/sab-international/yii2-gitea.svg)
![PHP](https://img.shields.io/packagist/php-v/cedx/yii2-gitea.svg) ![Yii Framework](https://img.shields.io/badge/yii-%3E%3D2.0-brightgreen.svg) ![Release](https://img.shields.io/packagist/v/cedx/yii2-gitea.svg) ![License](https://img.shields.io/packagist/l/cedx/yii2-gitea.svg) ![Downloads](https://img.shields.io/packagist/dt/cedx/yii2-gitea.svg) ![Coverage](https://coveralls.io/repos/github/cedx/yii2-gitea/badge.svg) ![Build](https://github.com/cedx/yii2-gitea/workflows/build/badge.svg)

[Gitea](https://gitea.io) connector for [Yii](https://www.yiiframework.com), high-performance [PHP](https://secure.php.net) framework.

## Documentation
- [User guide](https://dev.sabcomputer.com/yii2-gitea)
- [API reference](https://dev.sabcomputer.com/yii2-gitea/api)
- [User guide](https://dev.belin.io/yii2-gitea)
- [API reference](https://dev.belin.io/yii2-gitea/api)

## Development
- [Git repository](https://github.com/sab-international/yii2-gitea)
- [Packagist package](https://packagist.org/packages/sab-international/yii2-gitea)
- [Submit an issue](https://github.com/sab-international/yii2-gitea/issues)
- [Git repository](https://github.com/cedx/yii2-gitea)
- [Packagist package](https://packagist.org/packages/cedx/yii2-gitea)
- [Submit an issue](https://github.com/cedx/yii2-gitea/issues)

## License
[Gitea for Yii](https://dev.sabcomputer.com/yii2-gitea) is distributed under the MIT License.
[Gitea for Yii](https://dev.belin.io/yii2-gitea) is distributed under the MIT License.

+ 8
- 8
doc/about/see_also.md View File

@@ -1,15 +1,15 @@
# See also

## Development
- [API reference](https://dev.sabcomputer.com/yii2-gitea/api)
- [Packagist package](https://packagist.org/packages/sab-international/yii2-gitea)
- [Submit an issue](https://github.com/sab-international/yii2-gitea/issues)
- [API reference](https://dev.belin.io/yii2-gitea/api)
- [Packagist package](https://packagist.org/packages/cedx/yii2-gitea)
- [Submit an issue](https://github.com/cedx/yii2-gitea/issues)

## Testing
- [Continuous integration](https://travis-ci.com/sab-international/yii2-gitea)
- [Code coverage](https://coveralls.io/github/sab-international/yii2-gitea)
- [Continuous integration](https://travis-ci.com/cedx/yii2-gitea)
- [Code coverage](https://coveralls.io/github/cedx/yii2-gitea)

## Other implementations
- Dart: [Gitea for Dart](https://dev.sabcomputer.com/gitea.dart)
- JavaScript: [Gitea for JS](https://dev.sabcomputer.com/gitea.js)
- PHP: [Gitea for PHP](https://dev.sabcomputer.com/gitea.php)
- Dart: [Gitea for Dart](https://dev.belin.io/gitea.dart)
- JavaScript: [Gitea for JS](https://dev.belin.io/gitea.js)
- PHP: [Gitea for PHP](https://dev.belin.io/gitea.php)

+ 2
- 2
doc/index.md View File

@@ -1,5 +1,5 @@
# Gitea <small>for Yii</small>
![PHP](https://img.shields.io/packagist/php-v/sab-international/yii2-gitea.svg) ![Yii Framework](https://img.shields.io/badge/yii-%3E%3D2.0-brightgreen.svg) ![Release](https://img.shields.io/packagist/v/sab-international/yii2-gitea.svg) ![License](https://img.shields.io/packagist/l/sab-international/yii2-gitea.svg) ![Downloads](https://img.shields.io/packagist/dt/sab-international/yii2-gitea.svg) ![Coverage](https://coveralls.io/repos/github/sab-international/yii2-gitea/badge.svg) ![Build](https://travis-ci.com/sab-international/yii2-gitea.svg)
![PHP](https://img.shields.io/packagist/php-v/cedx/yii2-gitea.svg) ![Yii Framework](https://img.shields.io/badge/yii-%3E%3D2.0-brightgreen.svg) ![Release](https://img.shields.io/packagist/v/cedx/yii2-gitea.svg) ![License](https://img.shields.io/packagist/l/cedx/yii2-gitea.svg) ![Downloads](https://img.shields.io/packagist/dt/cedx/yii2-gitea.svg) ![Coverage](https://coveralls.io/repos/github/cedx/yii2-gitea/badge.svg) ![Build](https://travis-ci.com/cedx/yii2-gitea.svg)

[Gitea](https://gitea.io) connector for [Yii](https://www.yiiframework.com), high-performance [PHP](https://secure.php.net) framework.

@@ -9,7 +9,7 @@
Install the latest version of **Gitea for Yii** with [Composer](https://getcomposer.org):

```shell
composer require sab-international/yii2-gitea
composer require cedx/yii2-gitea
```

For detailed instructions, see the [installation guide](installation.md).

+ 1
- 1
doc/installation.md View File

@@ -27,7 +27,7 @@ composer --version
From a command prompt, run:

```shell
composer require sab-international/yii2-gitea
composer require cedx/yii2-gitea
```

### 2. Import it


etc/mkdocs.yaml → doc/mkdocs.yaml View File

@@ -1,27 +1,27 @@
site_name: Gitea for Yii
site_description: Gitea connector for Yii, high-performance PHP framework.
site_author: SAB International - contact@sabcomputer.com
site_url: https://dev.sabcomputer.com/yii2-gitea
site_author: Cédric Belin - cedric@belin.io
site_url: https://dev.belin.io/yii2-gitea

docs_dir: ../doc
site_dir: ../web

repo_name: GitHub
repo_url: https://github.com/sab-international/yii2-gitea
repo_url: https://github.com/cedx/yii2-gitea
edit_uri: ''

copyright: Copyright &copy; 2018 - 2019 SAB International
copyright: Copyright &copy; 2018 - 2020 Cédric Belin
google_analytics:
- !!python/object/apply:os.getenv [GOOGLE_ANALYTICS_ID]
- auto

extra:
social:
- {type: globe, link: 'http://www.sabcomputer.com'}
- {type: github, link: 'https://github.com/sab-international'}
- {type: globe, link: 'http://www.belin.io'}
- {type: github, link: 'https://github.com/cedx'}
- {type: facebook, link: 'https://www.facebook.com/sabinternational34'}
- {type: twitter, link: 'https://twitter.com/SABDistribution'}
- {type: linkedin, link: 'https://linkedin.com/company/sab-international-sarl'}
- {type: linkedin, link: 'https://linkedin.com/company/cedx-sarl'}

markdown_extensions:
- admonition

+ 2
- 2
test/index.php View File

@@ -10,7 +10,7 @@ $rootPath = dirname(__DIR__);
require_once "$rootPath/vendor/autoload.php";
require_once "$rootPath/vendor/yiisoft/yii2/Yii.php";
Yii::setAlias('@root', $rootPath);
Yii::setAlias('@yii/gitea', "$rootPath/src");
Yii::setAlias('@yii/gitea', "$rootPath/lib");

// Start the application.
new Application(['id' => 'yii2-gitea', 'basePath' => '@root/src']);
new Application(['id' => 'yii2-gitea', 'basePath' => '@root/lib']);

Loading…
Cancel
Save