Most recent edit on 2008-09-13 13:25:20 by BrianKoontz [added cat]
Additions:
CategoryWikkaCase
Edited on 2008-09-07 11:17:45 by BrianKoontz [Reorganized to reflect doc split]
Additions:
WikkaCase
WikkaCase∞ is a repository of tools, software projects, and plugins related to WikkaWiki. Any number of different types of Wikka-related projects can be hosted, including (but not limited to):
Installing a new plugin manually
Coming soon!
Installing a new plugin using the Plugin Manager
Coming soon!
Submitting bug reports and support requests
Coming soon!
Deletions:
WikkaCase (Contrib SVN Repository)
WikkaCase∞ is a repository of tools and software projects related to WikkaWiki. Any number of different types of Wikka-related projects can be hosted, including (but not limited to):
Setting up a new project
Accounts and projects are set up on an individual basis. You must register an account on the WikkaCase issue tracker∞, and you must provide us with a valid e-mail address. We will use this e-mail address to send you access information for Mantis and the SVN repository. Please note that at this time, we are not set up for secure transmission of passwords, so please be aware that passwords will be sent "in the clear." Do not use a valuable password that you don't want compromised!
After registering, submit a ticket in the Support Requests project. Include the following information:
- Project name
- Project type (action, handler, script, plugin, etc.)
- Project components (every project will have a default "core" component; other components are optional)
- Link to a companion page on the WikkaWiki∞ site (this page will serve as the "entry point" for your project)
Remember that all issues can be viewed by any user, so please don't post passwords or any other private information. Most of the Wikka devs have GPG keys if you need to send us secure information.
Once an account has been set up and your initial project is approved, you will be e-mailed a login ID and temporary password as well as any other instructions for accessing your project. We will also acknowledge project status in the ticket.
Creating tickets
WikkaCase provides each contributor with an issues tracking system for each hosted project that is accessible by everyone. Each project will have its own tracker.
Managing your project
You will be provided access to a Subversion (SVN) repository to manage your project(s). If you're not familiar with SVN, please consult //Version Control with Subversion∞ before requesting assistance.
All contributors are expected to be familiar with the Wikka coding guidelines∞. There will be no code reviews (we all have daytime jobs too!), but you will be doing yourself and other Wikka users a great favor by adhering as closely as possible to the guidelines. The easier your project is to install, understand, and maintain, the more likely it is that others will be interested in what you've created.
Using Mantis to manage issues/bug reports
The Mantis manual can be found here∞.
Source control
For source control, things are a little easier: each project gets its own project directory at the top level, and below that the standard trunk, branches and tags directories. That way, each project has its own virtual repository, and can be managed as usual. Contributors will have full access to their project directory and any subdirectories.
The first step is to initialize your project with initial directories. After receiving your log in credentials, check out an initial working copy of your new project (in this case, we'll call it TestRepo) and create the directories you'll need:
svn co https://www.pongonova.net/svn/TestRepo TestRepo
cd TestRepo
svn mkdir trunk
svn mkdir branches
svn mkdir tags
svn mkdir trunk/contrib
svn ci
TODO: Instructions for other SVN clients?
It is important that your project is configured in such a way that a user who checks out your project from the top-level Wikka directory (i.e., the directory containing wikka.config.php) will find that the files for your project have been installed into the proper directories. Please do not expect users to copy files from a temporary directory into the proper Wikka directories!
Each project must, at a minimum, be configured with the following directory structure:
- contrib
- projectname
- README.txt (contents TBD)
- (various support files, documentation, patches, etc.)
In addition, your project tree must also contain the Wikka directories that will be used for your project. Please note that Wikka directories change from version to version!
Example 1:
Your project name is CrazyAction, and it has been developed for Wikka 1.1.6.3. The project files include actions/crazyaction.php and a CSS file, css/crazyaction.css. There is also a small documentation file, crazyaction.txt. Your project tree (the one you check in to the repository) should look like:
A user who checked out your project in their Wikka 1.1.6.3 top-level directory would find that the files to your project have been checked out into the proper directories.
Example 2:
Same project as in Example 1, except it has been modified for Wikka 1.1.7. This version of Wikka introduces an extra directory layer in actions:
Documentation
Each project will be required to maintain a companion page on WikkaWiki. At a minimum, each project must include a link to the SVN repository and a link to the project on the Mantis issues tracker. It is not necessary to have a page for each hosted project (i.e., a contributor might host several projects on their own personal page). In addition, all contributors will be expected to become familiar with and implement "self-documenting" code via phpdoc (for more details, see the Code Documentation Tutorial). This will enable the auto-creation of documentation across all projects.
Announcing your releases
TODO: Mabye a dedicated topic on the blog? An announcement mailing list? A "What's New" sidebar on the wikkawiki.org home page with updates to a WikkaCaseProjects page? This one is wide open, folks...
Edited on 2008-09-07 11:14:17 by BrianKoontz [minor edit]
Additions:
- This page tells you how to install a new Wikka plugin using WikkaCase.
- For instructions on how to create a new Wikka plugin using WikkaCase, please visit the WikkaCaseDevHowto.
Deletions:
- This page tells you how to install a new Wikka plugin using WikkaCase.
- For instructions on how to create a new Wikka plugin using WikkaCase, please visit the WikkaCaseDevHowto.
Edited on 2008-09-07 11:12:53 by BrianKoontz [Explain dev/user doc split]
Additions:
- This page tells you how to install a new Wikka plugin using WikkaCase.
- For instructions on how to create a new Wikka plugin using WikkaCase, please visit the WikkaCaseDevHowto.
Edited on 2008-06-27 02:16:05 by BrianKoontz [Minor updates]
Additions:
WikkaCase∞ is a repository of tools and software projects related to WikkaWiki. Any number of different types of Wikka-related projects can be hosted, including (but not limited to):
The structure of WikkaCase has been designed to accommodate any type of project or contribution to WikkaWiki, whether just one file or script or a complex plugin or feature.
Accounts and projects are set up on an individual basis. You must register an account on the WikkaCase issue tracker∞, and you must provide us with a valid e-mail address. We will use this e-mail address to send you access information for Mantis and the SVN repository. Please note that at this time, we are not set up for secure transmission of passwords, so please be aware that passwords will be sent "in the clear." Do not use a valuable password that you don't want compromised!
After registering, submit a ticket in the Support Requests project. Include the following information:
- Link to a companion page on the WikkaWiki∞ site (this page will serve as the "entry point" for your project)
Deletions:
WikkaCase∞ is a repository of tools and software projects related to WikkaWiki. Any number of different types of Wikka-related projects can be hosted, including (but not limited to):
The structure of WikkaCase has been designed to accomodate any type of project or contribution to WikkaWiki, whether just one file or script or a complex plugin or feature.
Accounts and projects are set up on an individual basis. You must register an account on the WikkaCase site, and you must provide us with a valid e-mail address. We will use this e-mail address to send you access information for Mantis and the SVN repository. Please note that at this time, we are not set up for secure transmission of passwords, so please be aware that passwords will be sent "in the clear." Do not use a valuable password that you don't want compromised!
After registering, submit a ticket in the Support Requests project. Include the following information:
- Link to a companion page on the wikkawiki.org site (this page will serve as the "entry point" for your project)
Edited on 2008-01-28 00:16:26 by BrianKoontz [Modified links pointing to docs server]
No differences.
Edited on 2008-01-18 21:26:37 by BrianKoontz [additional doc requirements]
Additions:
Each project will be required to maintain a companion page on WikkaWiki. At a minimum, each project must include a link to the SVN repository and a link to the project on the Mantis issues tracker. It is not necessary to have a page for each hosted project (i.e., a contributor might host several projects on their own personal page). In addition, all contributors will be expected to become familiar with and implement "self-documenting" code via phpdoc (for more details, see the Code Documentation Tutorial). This will enable the auto-creation of documentation across all projects.
Deletions:
Each project will be required to maintain a companion page on WikkaWiki. It is not necessary to have a page for each hosted project (i.e., a contributor might host several projects on their own personal page). In addition, all contributors will be expected to become familiar with and implement "self-documenting" code via phpdoc (for more details, see the Code Documentation Tutorial). This will enable the auto-creation of documentation across all projects.
Edited on 2008-01-18 21:24:57 by BrianKoontz [define project SVN layout]
Additions:
The first step is to initialize your project with initial directories. After receiving your log in credentials, check out an initial working copy of your new project (in this case, we'll call it TestRepo) and create the directories you'll need:
svn co https://www.pongonova.net/svn/TestRepo TestRepo
cd TestRepo
svn mkdir trunk
svn mkdir branches
svn mkdir tags
svn mkdir trunk/contrib
svn ci
TODO: Instructions for other SVN clients?
Edited on 2008-01-18 21:11:01 by BrianKoontz [define project SVN layout]
Additions:
- contrib
- projectname
- README.txt (contents TBD)
- (various support files, documentation, patches, etc.)
Your project name is CrazyAction, and it has been developed for Wikka 1.1.6.3. The project files include actions/crazyaction.php and a CSS file, css/crazyaction.css. There is also a small documentation file, crazyaction.txt. Your project tree (the one you check in to the repository) should look like:
Same project as in Example 1, except it has been modified for Wikka 1.1.7. This version of Wikka introduces an extra directory layer in actions:
Deletions:
|
contrib
|
projectname
|
README.txt (contents TBD)
|
(various support files, documentation, patches, etc.)
Your project name is CrazyAction, and it has been developed for Wikka 1.1.6.3. The project files include actions/crazyaction.php and a CSS file, css/crazyaction.css. There is also a small documentation file, crazyaction.txt. Your project tree (the one you check in to the repository) should look like:
|
contrib
| |
CrazyAction
| |
crazyaction.txt
| |
README.txt
|
|
actions
| |
crazyaction.php
|
|
css
Edited on 2008-01-18 21:04:05 by BrianKoontz [define project SVN layout]
Additions:
It is important that your project is configured in such a way that a user who checks out your project from the top-level Wikka directory (i.e., the directory containing wikka.config.php) will find that the files for your project have been installed into the proper directories. Please do not expect users to copy files from a temporary directory into the proper Wikka directories!
Each project must, at a minimum, be configured with the following directory structure:
|
contrib
|
projectname
|
README.txt (contents TBD)
|
(various support files, documentation, patches, etc.)
In addition, your project tree must also contain the Wikka directories that will be used for your project. Please note that Wikka directories change from version to version!
Example 1:
Your project name is CrazyAction, and it has been developed for Wikka 1.1.6.3. The project files include actions/crazyaction.php and a CSS file, css/crazyaction.css. There is also a small documentation file, crazyaction.txt. Your project tree (the one you check in to the repository) should look like:
|
contrib
| |
CrazyAction
| |
crazyaction.txt
| |
README.txt
|
|
actions
| |
crazyaction.php
|
|
css
A user who checked out your project in their Wikka 1.1.6.3 top-level directory would find that the files to your project have been checked out into the proper directories.
Example 2:
Edited on 2008-01-14 00:40:39 by BrianKoontz [Updated to reflect new tracker (Mantis)]
Additions:
WikkaCase∞ is a repository of tools and software projects related to WikkaWiki. Any number of different types of Wikka-related projects can be hosted, including (but not limited to):
Accounts and projects are set up on an individual basis. You must register an account on the WikkaCase site, and you must provide us with a valid e-mail address. We will use this e-mail address to send you access information for Mantis and the SVN repository. Please note that at this time, we are not set up for secure transmission of passwords, so please be aware that passwords will be sent "in the clear." Do not use a valuable password that you don't want compromised!
After registering, submit a ticket in the Support Requests project. Include the following information:
Remember that all issues can be viewed by any user, so please don't post passwords or any other private information. Most of the Wikka devs have GPG keys if you need to send us secure information.
Once an account has been set up and your initial project is approved, you will be e-mailed a login ID and temporary password as well as any other instructions for accessing your project. We will also acknowledge project status in the ticket.
WikkaCase provides each contributor with an issues tracking system for each hosted project that is accessible by everyone. Each project will have its own tracker.
Using Mantis to manage issues/bug reports
The Mantis manual can be found here∞.
Deletions:
WikkaCase∞ is a repository of tools and software projects related to WikkaWiki. Any number of different types of Wikka-related projects can be hosted, including (but not limited to):
Accounts and projects are set up on an individual basis. At this time, only one user can have access to a project, and a user may have access to multiple projects. The actual repository structure for a project is described below.
The first step is to set up an account that will allow you to access the repository. (TODO: I'd like to suggest submitting user access requests via (1) trac using a dedicated component for that purpose, or (2) e-mail using a dedicated address. I would prefer (1) so that any one of the Wikka developers can act on a request and track the status. Option (2) might lead to duplication of tasks if there is a lag between working on a request and notifying the other developers.) A request for a new account must also include a project setup request. Each request must contain the following information:
- Contributor's name and contact e-mail
Once an account has been set up and your initial project is approved, you will be e-mailed a login ID and temporary password as well as any other instructions for accessing your project. Future project setup requests or requests for assistance must include your login ID.
WikkaCase provides each contributor with an issues tracking system for each hosted project that is accessible by everyone. Since WikkaCase hosts several projects, it is necessary to clearly indicate which (component of) which project a ticket refers to. Every project has at least one component named after the projects, and possibly others. So when creating a ticket, please make sure to select the project component it applies to, as well as the product version (prefixed by the project name)!
- We should probably rethink this policy. Allowing per-user access would not only require a level of trust be established with each contributor, but will also require some level of due diligence on the part of the Wikka devs to ensure that content being uploaded to the repository is suitable for inclusion. Even though Wikka is obviously not responsible for the content that's uploaded, there is still an implied approval of the content. Granted, there are per-user repositories (Perl CPAN∞ comes immediately to mind) associated with other OSS projects, but even CPAN relies on a manual approval process, regular testing of uploaded modules by volunteer testers, and a rating system. It would be difficult for someone to upload a malicious module to CPAN without someone noticing at some point in the process. I would propose that access to WikkaCase be restricted to a few volunteers who would then be responsible for commits. We could probably come up with some sort of semi-automated process whereby plugin developers who do not yet have SVN write access can make a tarball of their local repository and upload that for inclusion in the WikkaCase repo.
Using Trac to manage issues/bug reports
The current version of Trac isn't designed to keep track of multiple projects: versions, milestones, etc. are global to all issue management. Someone submitting a ticket will see all components, versions, etc. for all projects hosted here!
To help manage things in a such an environment -- and assist users who submit tickets -- all version numbers, milestones, branches and tags (releases) should be prefixed with project name (or, if there are subcomponents, with the component name). When assigning / accepting a ticket it would also be helpful to add at least the project name to the keywords so a query can quickly find all tickets that apply to a particular project.
By following these simple rules rigorously, it should be possible to use Trac to really manage multiple projects (provided they're not too complicated) even though it wasn't designed for that (yet...).
Edited on 2008-01-03 01:26:27 by BrianKoontz [Added comment critical of per-user repo access]
Additions:
- We should probably rethink this policy. Allowing per-user access would not only require a level of trust be established with each contributor, but will also require some level of due diligence on the part of the Wikka devs to ensure that content being uploaded to the repository is suitable for inclusion. Even though Wikka is obviously not responsible for the content that's uploaded, there is still an implied approval of the content. Granted, there are per-user repositories (Perl CPAN∞ comes immediately to mind) associated with other OSS projects, but even CPAN relies on a manual approval process, regular testing of uploaded modules by volunteer testers, and a rating system. It would be difficult for someone to upload a malicious module to CPAN without someone noticing at some point in the process. I would propose that access to WikkaCase be restricted to a few volunteers who would then be responsible for commits. We could probably come up with some sort of semi-automated process whereby plugin developers who do not yet have SVN write access can make a tarball of their local repository and upload that for inclusion in the WikkaCase repo.
Edited on 2007-05-08 16:11:03 by BrianKoontz [Minor edits]
Additions:
About WikkaCase
Setting up a new project
Creating tickets
WikkaCase provides each contributor with an issues tracking system for each hosted project that is accessible by everyone. Since WikkaCase hosts several projects, it is necessary to clearly indicate which (component of) which project a ticket refers to. Every project has at least one component named after the projects, and possibly others. So when creating a ticket, please make sure to select the project component it applies to, as well as the product version (prefixed by the project name)!
Managing your project
Using Trac to manage issues/bug reports
Source control
For source control, things are a little easier: each project gets its own project directory at the top level, and below that the standard trunk, branches and tags directories. That way, each project has its own virtual repository, and can be managed as usual. Contributors will have full access to their project directory and any subdirectories.
Documentation
Each project will be required to maintain a companion page on WikkaWiki. It is not necessary to have a page for each hosted project (i.e., a contributor might host several projects on their own personal page). In addition, all contributors will be expected to become familiar with and implement "self-documenting" code via phpdoc (for more details, see the Code Documentation Tutorial). This will enable the auto-creation of documentation across all projects.
Announcing your releases
Deletions:
About WikkaCase
Setting up a new project
Creating tickets
WikkaCase provides each contributor with an issues tracking system for each hosted project that is accessible by everyone. Since WikkaCase hosts several projects, it is necessary to clearly indicate which (component of) which project a ticket refers to. Every project has at least one component named after the projects, and possibly others. So when creating a ticket, please make sure to 'select the project component' it applies to, as well as the product version (prefixed by the project name)!
Managing your project
Using Trac to manage issues/bug reports
Source control
For source control, things are a little easier: each project gets its own 'project' directory at the top level, and below that the standard 'trunk', 'branches' and 'tags' directories. That way, each project has its own virtual repository, and can be managed as usual. Contributors will have full access to their project directory and any subdirectories.
Documentation
Each project will be required to maintain a companion page on WikkaWiki. It is not necessary to have a page for each hosted project (i.e., a contributor might host several projects on their own personal page). In addition, all contributors will be expected to become familiar with and implement "self-documenting" code via phpdoc (for more details, see the Code Documentation Tutorial). This will enable the auto-creation of documentation across all projects.
Announcing your releases
13:02 < brianko> so, what are the first steps we need to take to get WikkaCase rolling? A
guidelines draft?
13:02 <+DarTar> I think so
13:03 <+DarTar> - how to apply for an account
13:03 <+DarTar> - where to find coding guidelines etc.
13:03 <+DarTar> - some basic SVN references
13:03 <+DarTar> - how to announce a stable version of a plugin
13:04 <+DarTar> it's still very fluid
13:05 <+DarTar> but it might be interesting to contact some of the people who already
contributed code at wikkawiki.org once we have some guidelines
Edited on 2007-05-08 01:33:41 by BrianKoontz [draft]
Additions:
About WikkaCase
Setting up a new project
Creating tickets
Managing your project
Using Trac to manage issues/bug reports
Source control
Documentation
Announcing your releases
Deletions:
About WikkaCase
Setting up a new project
Creating tickets
Managing your project
Using Trac to manage issues/bug reports
Source control
Documentation
Announcing your releases
Edited on 2007-05-08 01:28:36 by BrianKoontz [draft]
Additions:
The structure of WikkaCase has been designed to accomodate any type of project or contribution to WikkaWiki, whether just one file or script or a complex plugin or feature.
Deletions:
The structure of WikkaCase has been designed to accomodate any type of project or contribution to "WikkaWiki", whether just one file or script or a complex plugin or feature.
Edited on 2007-05-08 01:28:15 by BrianKoontz [draft]
Additions:
WikkaCase∞ is a repository of tools and software projects related to WikkaWiki. Any number of different types of Wikka-related projects can be hosted, including (but not limited to):
Deletions:
WikkaCase∞ is a repository of tools and software projects related to [http://wikkawiki.org∞ WikkaWiki]. Any number of different types of Wikka-related projects can be hosted, including (but not limited to):
Edited on 2007-05-08 01:27:47 by BrianKoontz [draft]
Additions:
About WikkaCase
WikkaCase∞ is a repository of tools and software projects related to [http://wikkawiki.org∞ WikkaWiki]. Any number of different types of Wikka-related projects can be hosted, including (but not limited to):
The structure of WikkaCase has been designed to accomodate any type of project or contribution to "WikkaWiki", whether just one file or script or a complex plugin or feature.
Setting up a new project
Accounts and projects are set up on an individual basis. At this time, only one user can have access to a project, and a user may have access to multiple projects. The actual repository structure for a project is described below.
The first step is to set up an account that will allow you to access the repository. (TODO: I'd like to suggest submitting user access requests via (1) trac using a dedicated component for that purpose, or (2) e-mail using a dedicated address. I would prefer (1) so that any one of the Wikka developers can act on a request and track the status. Option (2) might lead to duplication of tasks if there is a lag between working on a request and notifying the other developers.) A request for a new account must also include a project setup request. Each request must contain the following information:
- Contributor's name and contact e-mail
- Project name
- Project type (action, handler, script, plugin, etc.)
- Project components (every project will have a default "core" component; other components are optional)
- Link to a companion page on the wikkawiki.org site (this page will serve as the "entry point" for your project)
Once an account has been set up and your initial project is approved, you will be e-mailed a login ID and temporary password as well as any other instructions for accessing your project. Future project setup requests or requests for assistance must include your login ID.
Creating tickets
WikkaCase provides each contributor with an issues tracking system for each hosted project that is accessible by everyone. Since WikkaCase hosts several projects, it is necessary to clearly indicate which (component of) which project a ticket refers to. Every project has at least one component named after the projects, and possibly others. So when creating a ticket, please make sure to 'select the project component' it applies to, as well as the product version (prefixed by the project name)!
Managing your project
You will be provided access to a Subversion (SVN) repository to manage your project(s). If you're not familiar with SVN, please consult //Version Control with Subversion∞ before requesting assistance.
All contributors are expected to be familiar with the Wikka coding guidelines∞. There will be no code reviews (we all have daytime jobs too!), but you will be doing yourself and other Wikka users a great favor by adhering as closely as possible to the guidelines. The easier your project is to install, understand, and maintain, the more likely it is that others will be interested in what you've created.
Using Trac to manage issues/bug reports
The current version of Trac isn't designed to keep track of multiple projects: versions, milestones, etc. are global to all issue management. Someone submitting a ticket will see all components, versions, etc. for all projects hosted here!
To help manage things in a such an environment -- and assist users who submit tickets -- all version numbers, milestones, branches and tags (releases) should be prefixed with project name (or, if there are subcomponents, with the component name). When assigning / accepting a ticket it would also be helpful to add at least the project name to the keywords so a query can quickly find all tickets that apply to a particular project.
Source control
For source control, things are a little easier: each project gets its own 'project' directory at the top level, and below that the standard 'trunk', 'branches' and 'tags' directories. That way, each project has its own virtual repository, and can be managed as usual. Contributors will have full access to their project directory and any subdirectories.
Documentation
Each project will be required to maintain a companion page on WikkaWiki. It is not necessary to have a page for each hosted project (i.e., a contributor might host several projects on their own personal page). In addition, all contributors will be expected to become familiar with and implement "self-documenting" code via phpdoc (for more details, see the Code Documentation Tutorial). This will enable the auto-creation of documentation across all projects.
Announcing your releases
TODO: Mabye a dedicated topic on the blog? An announcement mailing list? A "What's New" sidebar on the wikkawiki.org home page with updates to a WikkaCaseProjects page? This one is wide open, folks...
Deletions:
WikkaCase is a repository of tools and software projects related to [http://wikkawiki.org∞ WikkaWiki]. Any number of different types of Wikka-related projects can be hosted, including (but not limited to):
The structure of WikkaCase has been designed in such a way that
Hosted projects
!WikkaCase currently hosts the following projects:
* !WikkaBots
* [http://wikkawiki.org/WikkaEdit∞ WikkaEdit]
Creating tickets
Since !WikkaCase hosts several projects, it is necessary to clearly indicate which (component of) which project a ticket refers to. Every project has at least one component named after the projects, and possibly others. So when creating a ticket, please make sure to 'select the project component' it applies to, as well as the product version (prefixed by the project name)!
Managing multiple projects
Project management
The current version of Trac isn't designed to keep track of multiple projects: versions, milestones, etc. are global to all issue management. Someone submitting a ticket will see all components, versions, etc. for all projects hosted here!
To help manage things in a such an environment -- and assist users who submit tickets -- 'all' version numbers, milestones, branches and tags (releases) should be prefixed with project name (or, if there are subcomponents, with the component name). When assigning / accepting a ticket it would also be helpful to add at least the project name to the keywords so a query can quickly find all tickets that apply to a particular project.
Source control
For source control, things are a little easier: each project gets its own 'project' directory at the top level, and below that the standard 'trunk', 'branches' and 'tags' directories. That way, each project has its own virtual repository, and can be managed as usual.
Edited on 2007-05-08 00:51:09 by BrianKoontz
Additions:
WikkaCase is a repository of tools and software projects related to [http://wikkawiki.org∞ WikkaWiki]. Any number of different types of Wikka-related projects can be hosted, including (but not limited to):
- 3rd party software used by Wikka;
- User contributions (skins, actions, handlers, etc.);
- Maintenance scripts and programs
The structure of WikkaCase has been designed in such a way that
Deletions:
TOC
= Welcome to !WikkaCase =
!WikkaCase is a repository of tools and software projects related to [http://wikkawiki.org∞ WikkaWiki].
Edited on 2007-05-08 00:46:39 by BrianKoontz
Additions:
WikkaCase (Contrib SVN Repository)
TOC
= Welcome to !WikkaCase =
!WikkaCase is a repository of tools and software projects related to [http://wikkawiki.org∞ WikkaWiki].
Hosted projects
!WikkaCase currently hosts the following projects:
* !WikkaBots
* [http://wikkawiki.org/WikkaEdit∞ WikkaEdit]
Creating tickets
Since !WikkaCase hosts several projects, it is necessary to clearly indicate which (component of) which project a ticket refers to. Every project has at least one component named after the projects, and possibly others. So when creating a ticket, please make sure to 'select the project component' it applies to, as well as the product version (prefixed by the project name)!
Managing multiple projects
Project management
The current version of Trac isn't designed to keep track of multiple projects: versions, milestones, etc. are global to all issue management. Someone submitting a ticket will see all components, versions, etc. for all projects hosted here!
To help manage things in a such an environment -- and assist users who submit tickets -- 'all' version numbers, milestones, branches and tags (releases) should be prefixed with project name (or, if there are subcomponents, with the component name). When assigning / accepting a ticket it would also be helpful to add at least the project name to the keywords so a query can quickly find all tickets that apply to a particular project.
By following these simple rules rigorously, it should be possible to use Trac to really manage multiple projects (provided they're not too complicated) even though it wasn't designed for that (yet...).
Source control
For source control, things are a little easier: each project gets its own 'project' directory at the top level, and below that the standard 'trunk', 'branches' and 'tags' directories. That way, each project has its own virtual repository, and can be managed as usual.
Deletions:
Wikka Case (Contrib SVN Repository)
Oldest known version of this page was edited on 2007-05-03 14:16:28 by BrianKoontz []
Page view:
DRAFT
Wikka Case (Contrib SVN Repository)
13:02 < brianko> so, what are the first steps we need to take to get WikkaCase rolling? A
guidelines draft?
13:02 <+DarTar> I think so
13:03 <+DarTar> - how to apply for an account
13:03 <+DarTar> - where to find coding guidelines etc.
13:03 <+DarTar> - some basic SVN references
13:03 <+DarTar> - how to announce a stable version of a plugin
13:04 <+DarTar> it's still very fluid
13:05 <+DarTar> but it might be interesting to contact some of the people who already
contributed code at wikkawiki.org once we have some guidelines