... | @@ -13,9 +13,7 @@ order to ask for a project to be created. You will need to specify: |
... | @@ -13,9 +13,7 @@ order to ask for a project to be created. You will need to specify: |
|
3. Brief description of your project
|
|
3. Brief description of your project
|
|
4. Type of license
|
|
4. Type of license
|
|
5. Initial team
|
|
5. Initial team
|
|
6. Repository type: svn or git (hard to change afterwards). Git is
|
|
6. Any special requirements
|
|
recommended.
|
|
|
|
7. Any special requirements
|
|
|
|
|
|
|
|
## Guidelines
|
|
## Guidelines
|
|
|
|
|
... | @@ -26,16 +24,15 @@ order to ask for a project to be created. You will need to specify: |
... | @@ -26,16 +24,15 @@ order to ask for a project to be created. You will need to specify: |
|
|
|
|
|
## OHWR features
|
|
## OHWR features
|
|
|
|
|
|
Redmine provides the following modules per Project
|
|
GitLab provides the following modules per Project
|
|
|
|
|
|
1. Issue management & time tracking (via tickets)
|
|
1. Issue management & time tracking (via tickets)
|
|
2. News module
|
|
2. Documents module
|
|
3. Documents module
|
|
3. Files module
|
|
4. Files module
|
|
4. Wikis (1 per project)
|
|
5. Wikis (1 per project)
|
|
5. Forums (can create multiple forums per project)
|
|
6. Forums (can create multiple forums per project)
|
|
6. git repositories (1 per project)
|
|
7. svn or git repositories (1 per project)
|
|
7. Mailing lists (1 per project)
|
|
8. Mailing lists (1 per project)
|
|
|
|
|
|
|
|
## Recommended setup & usage
|
|
## Recommended setup & usage
|
|
|
|
|
... | @@ -81,7 +78,7 @@ We recommend the following usage of the OHR project functionality: |
... | @@ -81,7 +78,7 @@ We recommend the following usage of the OHR project functionality: |
|
For this the Issues need to have a "Target version" set.
|
|
For this the Issues need to have a "Target version" set.
|
|
5. The **mailing list** is the preferred way of communication, but you
|
|
5. The **mailing list** is the preferred way of communication, but you
|
|
can also use forums.
|
|
can also use forums.
|
|
6. Use subversion (SVN) or Git (most often used) for all kinds of files
|
|
6. Use Git for all kinds of files
|
|
requiring **version management**: HDL and software/firmware,
|
|
requiring **version management**: HDL and software/firmware,
|
|
schematics, PCB layout, manufacturing files, etc.
|
|
schematics, PCB layout, manufacturing files, etc.
|
|
7. Use the **Documents** module for providing "release" versions of
|
|
7. Use the **Documents** module for providing "release" versions of
|
... | @@ -152,99 +149,21 @@ If you have requested it, your project will include a *git* repository. |
... | @@ -152,99 +149,21 @@ If you have requested it, your project will include a *git* repository. |
|
Actually Git is the most used repository type that is also more flexible
|
|
Actually Git is the most used repository type that is also more flexible
|
|
than SVN
|
|
than SVN
|
|
See the [dedicated wiki page](Git-Repositories) for details.
|
|
See the [dedicated wiki page](Git-Repositories) for details.
|
|
|
|
|
|
### SVN
|
|
|
|
|
|
|
|
If you have requested it, your project will include a
|
|
|
|
[subversion](http://subversion.apache.org/) repository. All project's
|
|
|
|
repositories are available on the following URL:
|
|
|
|
|
|
|
|
http://svn.ohwr.org
|
|
|
|
|
|
|
|
You can calculate the complete url of your repository by adding `/` and
|
|
|
|
your project's identifier to that url. For example, the source code of
|
|
|
|
this page is on the `ohr-support` repository:
|
|
|
|
|
|
|
|
http://svn.ohwr.org/ohr-support
|
|
|
|
|
|
|
|
This URL is publicly available on read-mode (everyone can "update" from
|
|
|
|
these repositories).
|
|
|
|
|
|
|
|
Anyone wanting to commit changes to a project will have to be
|
|
Anyone wanting to commit changes to a project will have to be
|
|
authenticated as a developer or manager on that project.
|
|
authenticated as a developer or manager on that project.
|
|
|
|
|
|
#### Create an SVN repo
|
|
## Mailing Lists
|
|
|
|
|
|
cd /var/svn
|
|
|
|
sudo svnadmin create <repo-name> --fs-type fsfs
|
|
|
|
sudo chown -R www-data <repo-name>
|
|
|
|
|
|
|
|
If you only want to browse the source code, notice that Redmine provides
|
|
|
|
a nicer interface via its "Repository" tab (you should see it on the
|
|
|
|
toolbar, above this text). It is also possible to include links to
|
|
|
|
particular releases or files (see the "wiki editing
|
|
|
|
guide"/help/wiki\_syntax\_detailed.html for details).
|
|
|
|
|
|
|
|
## Mailing Lists (Sympa)
|
|
|
|
|
|
|
|
If you have requested it, your project will include a mailing list.
|
|
|
|
Mailing lists are managed via a [sympa](http://www.sympa.org/)
|
|
|
|
interface.
|
|
|
|
|
|
|
|
OHWR's mailing lists interface is available here:
|
|
|
|
|
|
|
|
http://lists.ohwr.org
|
|
|
|
|
|
|
|
You can calculate the complete url of your mailing list's by adding
|
|
|
|
`/sympa/info/` and your project's identifier to that url. For example,
|
|
|
|
`ohr-support`'s mailing list page is here:
|
|
|
|
|
|
|
|
http://lists.ohwr.org/sympa/info/ohr-support
|
|
|
|
|
|
|
|
From there, you can browse the mailing list's archive, list of users,
|
|
|
|
etc.
|
|
|
|
|
|
|
|
Mailing list archives are publicly available. There's no way to make
|
|
|
|
private mailing lists.
|
|
|
|
|
|
|
|
If you are a project's manager, an account will be created for you on
|
|
|
|
the sympa system. Your login and password will be the same as you use on
|
|
|
|
the ohwr site. You will have owner rights over that list.
|
|
|
|
|
|
|
|
Appart from that, sympa's subscriptions are separated and independent
|
|
|
|
from the rest of ohwr's accounts; It's possible to be a member of a
|
|
|
|
project, and not be subscribed to its mailing list (in fact, newly
|
|
|
|
created users are NOT automatically subscribed to the project's mailing
|
|
|
|
list; they have to proactively subscribe - see below). It's also
|
|
|
|
possible to be subscribed to a sympa mailing list while not having a
|
|
|
|
project account (this is useful for external mail-only collaborators).
|
|
|
|
|
|
|
|
There isn't any procedure for automatically subscribing new project
|
|
|
|
users to a mailing lists; only list owners are created automatically
|
|
|
|
from project managers. The sympa web interface provides the lists owners
|
|
|
|
with a way to mass-subscribe lots of users via uploading of a text file.
|
|
|
|
We however recommend keeping the subscription voluntary.
|
|
|
|
|
|
|
|
The instructions for joining a list can be found on each project's
|
|
|
|
"Mailing List" tab; see [ohr-support mailing list
|
|
|
|
page](https://www.ohwr.org/mailing_list/show?project_id=ohr-support) for
|
|
|
|
an example.
|
|
|
|
|
|
|
|
Mailing lists are open; anyone can send an email to them, including
|
|
|
|
unregistered users. Emails from unregistered users will be moderated by
|
|
|
|
the mailing list owners (they will receive a private email when an email
|
|
|
|
from an unregistered user arrives).
|
|
|
|
|
|
|
|
# Backup
|
|
To be updated with Forums
|
|
|
|
|
|
In order to make a full server backup, you may download the Rakefile
|
|
# Other
|
|
from our repository [link](https://www.ohwr.org/project/ohr-support/blob/mastertrunk/backup/Rakefile.)
|
|
|
|
|
|
|
|
Please read its comments and configure it properly before using it.
|
|
* [Open Source Guides](https://opensource.guide)
|
|
|
|
** Open Source Guides were created and are curated by GitHub
|
|
|
|
|
|
-----
|
|
-----
|
|
|
|
|
|
12 June 2018
|
|
6 November 2019
|
|
|
|
|
|
|
|
|
|
|
|
|
... | | ... | |