docs: remove folder "docs"
This commit is contained in:
vnmedeiros
parent
9081972884
commit
82728e42af
|
|
@ -1,23 +0,0 @@
|
|||
## Contribution guidelines
|
||||
|
||||
Interested in contributing to Tainacan? That's awesome! :muscle: In this page, we'll talk about paths of contribution and what we consider a quality contribution.
|
||||
|
||||
### Our language policy
|
||||
While Tainacan is a Brazilian project, we have adopted English as our primary language on development matters. Writing comments in Portuguese on [issues](https://github.com/tainacan/tainacan/issues) and [pull requests](https://github.com/tainacan/tainacan/pulls) is allowed as long as you provide an English translation of your comments. Writing comments in Portuguese on commits is expressively prohibited. Comments on the codebase and variable names should also be written in English only.
|
||||
|
||||
### Thinking about how you can contribute
|
||||
|
||||
Ask yourself the following questions: do you work, directly or indirectly, with cultural preservation? If yes, what do you do? If not, are you just a curious person just excited about it? What kind of skills do you have? Is there something you find fun to do you think you can shape as a contribution to Tainacan?
|
||||
|
||||
Free and open source projects offer a diversity of contributions options that go from direct involvement with the development of a software (submiting patches to eliminate a bug, implementing new features, creating new tests) to works related to localization (translating the software interface), design (creative works), user experience (testing new iterations of Tainacan and reporting issues), documentation (contributing to our wiki with new articles or improving existing ones) and communication (creating videos about Tainacan, giving talks mentioning it). Here, we'll talk about in particular about contributions to this repository.
|
||||
|
||||
### Issue system
|
||||
An issue is a thread within the project's GitHub repository focused on debating bugs, feature requests or errors one may stumble upon. To gather as much information as possible and organize discussions to be clearer and more searchable, this repository has a few templates for the most common issues:
|
||||
|
||||
#### Bug report
|
||||
If something is not working properly on Tainacan, use this template.
|
||||
|
||||
#### Feature request
|
||||
If you have any feature ideas you would like to suggest to our developers, use this template.
|
||||
|
||||
A great issue is one that includes a concise description of errors you are stumbling upon along with crucial information such as which version of Tainacan you are using, which web browser, or which WordPress version. It's also important to search our repository for duplicates—and if you find one, opt to participate in the original discussion adding new information instead of creating your own. That will help contributors and users to keep track of a specific subject more easily.
|
||||
|
|
@ -1 +0,0 @@
|
|||
You can find all of Tainacan documentation in our Wiki: [https://wiki.tainacan.org](https://wiki.tainacan.org)
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 34 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 26 KiB |
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1,291 +0,0 @@
|
|||
<?php
|
||||
/**
|
||||
* File used to generate docs for the repositories classes
|
||||
*
|
||||
* change the line below to the path to the wp-config of a WP installation
|
||||
*
|
||||
* Dont forget to set the language of your WordPress to english
|
||||
*/
|
||||
//include('/path/to/wp-config.php');
|
||||
|
||||
$repos = [
|
||||
|
||||
'collections' => [
|
||||
'instance' => \Tainacan\Repositories\Collections::get_instance(),
|
||||
'methods' => [
|
||||
[
|
||||
'name' => 'fetch',
|
||||
],
|
||||
[
|
||||
'name' => 'fetch_one',
|
||||
],
|
||||
[
|
||||
'name' => 'insert',
|
||||
],
|
||||
[
|
||||
'name' => 'update',
|
||||
],
|
||||
[
|
||||
'name' => 'delete',
|
||||
],
|
||||
[
|
||||
'name' => 'trash',
|
||||
]
|
||||
]
|
||||
],
|
||||
'metadata' => [
|
||||
'instance' => \Tainacan\Repositories\Metadata::get_instance(),
|
||||
'methods' => [
|
||||
[
|
||||
'name' => 'fetch',
|
||||
],
|
||||
[
|
||||
'name' => 'fetch_one',
|
||||
],
|
||||
[
|
||||
'name' => 'fetch_ids',
|
||||
],
|
||||
[
|
||||
'name' => 'fetch_by_collection',
|
||||
],
|
||||
[
|
||||
'name' => 'fetch_ids_by_collection',
|
||||
],
|
||||
[
|
||||
'name' => 'fetch_metadata_types',
|
||||
],
|
||||
[
|
||||
'name' => 'get_core_metadata',
|
||||
],
|
||||
[
|
||||
'name' => 'get_core_title_metadatum',
|
||||
],
|
||||
[
|
||||
'name' => 'get_core_description_metadatum',
|
||||
],
|
||||
[
|
||||
'name' => 'fetch_all_metadatum_values',
|
||||
],
|
||||
[
|
||||
'name' => 'insert',
|
||||
],
|
||||
[
|
||||
'name' => 'update',
|
||||
],
|
||||
[
|
||||
'name' => 'delete',
|
||||
],
|
||||
[
|
||||
'name' => 'trash',
|
||||
]
|
||||
]
|
||||
],
|
||||
'filters' => [
|
||||
'instance' => \Tainacan\Repositories\Filters::get_instance(),
|
||||
'methods' => [
|
||||
[
|
||||
'name' => 'fetch',
|
||||
],
|
||||
[
|
||||
'name' => 'fetch_one',
|
||||
],
|
||||
[
|
||||
'name' => 'fetch_ids',
|
||||
],
|
||||
[
|
||||
'name' => 'fetch_by_collection',
|
||||
],
|
||||
[
|
||||
'name' => 'fetch_ids_by_collection',
|
||||
],
|
||||
[
|
||||
'name' => 'insert',
|
||||
],
|
||||
[
|
||||
'name' => 'update',
|
||||
],
|
||||
[
|
||||
'name' => 'delete',
|
||||
],
|
||||
[
|
||||
'name' => 'trash',
|
||||
]
|
||||
]
|
||||
],
|
||||
'items' => [
|
||||
'instance' => \Tainacan\Repositories\Items::get_instance(),
|
||||
'methods' => [
|
||||
[
|
||||
'name' => 'fetch',
|
||||
],
|
||||
[
|
||||
'name' => 'fetch_one',
|
||||
],
|
||||
[
|
||||
'name' => 'fetch_ids',
|
||||
],
|
||||
[
|
||||
'name' => 'get_thumbnail_id_from_document',
|
||||
],
|
||||
[
|
||||
'name' => 'insert',
|
||||
],
|
||||
[
|
||||
'name' => 'update',
|
||||
],
|
||||
[
|
||||
'name' => 'delete',
|
||||
],
|
||||
[
|
||||
'name' => 'trash',
|
||||
]
|
||||
]
|
||||
],
|
||||
'taxonomies' => [
|
||||
'instance' => \Tainacan\Repositories\Taxonomies::get_instance(),
|
||||
'methods' => [
|
||||
[
|
||||
'name' => 'fetch',
|
||||
],
|
||||
[
|
||||
'name' => 'fetch_one',
|
||||
],
|
||||
[
|
||||
'name' => 'fetch_by_collection',
|
||||
],
|
||||
[
|
||||
'name' => 'term_exists',
|
||||
],
|
||||
[
|
||||
'name' => 'insert',
|
||||
],
|
||||
[
|
||||
'name' => 'update',
|
||||
],
|
||||
[
|
||||
'name' => 'delete',
|
||||
],
|
||||
[
|
||||
'name' => 'trash',
|
||||
]
|
||||
]
|
||||
],
|
||||
'terms' => [
|
||||
'instance' => \Tainacan\Repositories\Terms::get_instance(),
|
||||
'methods' => [
|
||||
[
|
||||
'name' => 'fetch',
|
||||
],
|
||||
[
|
||||
'name' => 'fetch_one',
|
||||
],
|
||||
[
|
||||
'name' => 'insert',
|
||||
],
|
||||
[
|
||||
'name' => 'update',
|
||||
],
|
||||
[
|
||||
'name' => 'delete',
|
||||
],
|
||||
[
|
||||
'name' => 'trash',
|
||||
]
|
||||
]
|
||||
],
|
||||
// 'item-metadata' => [
|
||||
// 'instance' => \Tainacan\Repositories\Item_Metadata::get_instance(),
|
||||
// 'methods' => [
|
||||
// [
|
||||
// 'name' => 'fetch',
|
||||
// ],
|
||||
// [
|
||||
// 'name' => 'get_value',
|
||||
// ],
|
||||
// [
|
||||
// 'name' => 'insert',
|
||||
// ],
|
||||
// [
|
||||
// 'name' => 'delete',
|
||||
// ],
|
||||
// [
|
||||
// 'name' => 'trash',
|
||||
// ]
|
||||
// ]
|
||||
// ],
|
||||
|
||||
|
||||
];
|
||||
|
||||
function get_method_doc($repo, $method) {
|
||||
|
||||
//return '';
|
||||
|
||||
$r = new ReflectionMethod($repo, $method);
|
||||
$doc = $r->getDocComment();
|
||||
$doc = str_replace('/**', '', $doc);
|
||||
$doc = str_replace('*/', '', $doc);
|
||||
$doc = str_replace(' * ', '', $doc);
|
||||
$doc = str_replace(' *', '', $doc);
|
||||
$doc = preg_replace('/\t+/', '', $doc );
|
||||
return $doc;
|
||||
}
|
||||
|
||||
foreach ($repos as $name => $repo) {
|
||||
$i = $repo['instance'];
|
||||
$map = $i->get_map();
|
||||
$entity = $i->entities_type;
|
||||
$entity = strtolower( str_replace('\Tainacan\Entities\\', '', $entity) );
|
||||
$target_file = 'repository-' . $name . '.md';
|
||||
ob_start();
|
||||
?>
|
||||
|
||||
# <?= $i->get_name(); ?> Repository
|
||||
|
||||
## Main Methods
|
||||
|
||||
These are the most used methods of this repository. For a complete list see [the repository file](../src/classes/repositories/class-tainacan-<?= $name; ?>.php).
|
||||
|
||||
<?php foreach ($repo['methods'] as $method): ?>
|
||||
|
||||
### <?= $method['name']; ?>()
|
||||
|
||||
<?= get_method_doc(get_class($i), $method['name']); ?>
|
||||
|
||||
<?php endforeach; ?>
|
||||
|
||||
## Usage
|
||||
|
||||
```PHP
|
||||
$repository = \Tainacan\Repositories\<?= $i->get_name(); ?>::get_instance();
|
||||
```
|
||||
|
||||
## Entity Properties
|
||||
|
||||
These are the Entity attributes for this repository. The Entity class is at [classes/entities folder](../src/classes/entities/class-tainacan-<?= $entity; ?>.php)
|
||||
|
||||
Property | Description | Slug | Getter | Setter | Stored as
|
||||
--- | --- | --- | --- | --- | ---
|
||||
<?php foreach ($map as $s => $m): ?>
|
||||
<?= $m['title']; ?>|<?= $m['description']; ?>|<?= $s; ?>|`$entity->get_<?= $s; ?>()`|`$entity->set_<?= $s; ?>()`|<?= $m['map'] . "\n"; ?>
|
||||
<?php endforeach; ?>
|
||||
|
||||
### Entity usage
|
||||
|
||||
|
||||
Create new
|
||||
|
||||
```PHP
|
||||
$entity = new <?= $i->entities_type; ?>();
|
||||
```
|
||||
|
||||
Get existing by ID
|
||||
```PHP
|
||||
$repository = \Tainacan\Repositories\<?= $i->get_name(); ?>::get_instance();
|
||||
$entity = $repository->fetch(12);
|
||||
echo 'My ID is ' . $entity->get_id(); // 12
|
||||
```
|
||||
|
||||
<?php
|
||||
file_put_contents($target_file, ob_get_clean());
|
||||
}
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
|
|
@ -1 +0,0 @@
|
|||
This page was moved to https://tainacan.github.io/tainacan-wiki/
|
||||
Loading…
Reference in New Issue