3,699
edits
mNo edit summary |
mNo edit summary |
||
(6 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{TOCright}} | {{TOCright}} | ||
This pages content is | This pages content is centred around MyList Export development AniDB's GIT. The goals of the GIT are: | ||
# Keeping track of all | # Keeping track of all MyList Export templates. | ||
# Version control for developers. | # Version control for developers. | ||
# | # Automatic upload procedure to one of AniDB's server. | ||
# | # Automatic update of the export template selection on the MyList export page. | ||
==Getting the Source of a Template== | ==Getting the Source of a Template== | ||
If you only want to get the latest version of all files belonging to a particular template, you don't need to install an | If you only want to get the latest version of all files belonging to a particular template, you don't need to install an GIT client. A simpler approach would be to download the files from the GIT repository with your web browser. | ||
To do that go to [ | To do that go to [https://git.anidb.net/anidb/export/tree/master gitlab] and click the download link. | ||
If you want to contribute your own | If you want to contribute your own template, you will need to install a git client. | ||
==Connecting to | ==Connecting to GIT== | ||
[https://git.anidb.net https://git.anidb.net] - [https://git.anidb.net/anidb/export/tree/master Direct access to public repo] | |||
If you | For write access just sign up to the git. If you have further questions feel free to ask in {{irclink|anidb-dev}} or {{irclink|anidb}}. | ||
===Committing=== | ===Committing=== | ||
After you have edited, added or even deleted some things you still have to commit your changes. This will write the things to the | After you have edited, added or even deleted some things you still have to commit your changes. This will write the things to the GIT. | ||
You can commit on a file or dirlevel. Meaning you can commit a big change with multiple files or folders involved or just specific files. '''To not spam us all into oblivion with | You can commit on a file or dirlevel. Meaning you can commit a big change with multiple files or folders involved or just specific files. '''To not spam us all into oblivion with GIT mails it's recommended to bundle some commits.''' | ||
Take also note that you should before editing anything '''always''' update your local files with the ones in the | Take also note that you should before editing anything '''always''' update your local files with the ones in the GIT. | ||
==Adding a new project== | ==Adding a new project== | ||
There are a few things that needs to get done when adding a new project: | There are a few things that needs to get done when adding a new project: | ||
# Add a new dir for your project in the export folder (<tt>/trunk/export/{your_template}</tt>) | # Add a new dir for your project in the export folder (<tt>/trunk/export/{your_template}</tt>) | ||
# Name the dir whatever you want, but '''NO SPACES!''' and lower | # Name the dir whatever you want, but '''NO SPACES!''' and lower case only. | ||
#* The name should contain the appropriate prefix, i.e. html-XXX for an html export template, xml-XXX if the template generates | #* The name should contain the appropriate prefix, i.e. html-XXX for an html export template, xml-XXX if the template generates XML output, ... | ||
# If you are using images different from the | # If you are using images different from the AniDB ones add a <tt>/images/</tt> dir below your project (i.e. <tt>/trunk/export/{your_template}/images</tt>) | ||
#* FIXME: not sure if the current export code actually supports an images directory - [[User:Exp|Exp]] 07:49, 28 June 2007 (UTC) | #* FIXME: not sure if the current export code actually supports an images directory - [[User:Exp|Exp]] 07:49, 28 June 2007 (UTC) | ||
#* You may use subfolders below that one if you want. | #* You may use subfolders below that one if you want. | ||
In the end you should end up with a structure like this: | In the end you should end up with a structure like this: | ||
/<your project> | |||
/<your project>/images | |||
==Merging & Hosting== | ==Merging & Hosting== | ||
Every template when finished, gets uploaded to | Every template when finished, gets uploaded to one of AniDB's servers and added to the export template page selection in the {{AniDBLink|export|AniDB MyList export page}}. | ||
[[Category:Development]] | [[Category:Development]] | ||
[[Category: | [[Category:Mylist export]] |