README.md 2.73 KB
Newer Older
1
# Public Heptapod FOSS instance
Georges Racinet's avatar
Georges Racinet committed
2

3
It is hosted at [foss.heptapod.net](https://foss.heptapod.net)
Georges Racinet's avatar
Georges Racinet committed
4

5
6
7
8
9
10
11
12
## Administration

This instance is managed by a team of community members, including but not
restricted to people from Octobus and Clever Cloud.

See the [separate page about administration](administration.md)


13
## Admissible projects
Georges Racinet's avatar
Georges Racinet committed
14

15
On this service, users are not allowed to create new projects at will.
16

17
18
All Free and Open Source projects are welcome on foss.heptapod.net,
as far as the current resources permit.
Georges Racinet's avatar
Georges Racinet committed
19

20
21
22
If you want some project to be hosted, please create an issue on the present
project with the "Hosting Request" template. Upon approval, we will usually
allow you to create what you need.
Georges Racinet's avatar
Georges Racinet committed
23

24
25
26
Note: to avoid confusing situations, we require that the person requesting
hosting be an official maintainer of the project, or to have been publically
asked to do so by a maintainer.
27

Georges Racinet's avatar
Georges Racinet committed
28
29
### Maintainer task list for the import to happen

30
31
32
33
34
Once the Hosting Request is approved, it should be assigned to one of the
site-wide administrators, who will give the needed rights or create a group
with the proper ownership.

#### Identification
Georges Racinet's avatar
Georges Racinet committed
35

36
We need to be sure that authors hosting requests are who they claim to be.
Georges Racinet's avatar
Georges Racinet committed
37

38
39
One way to do that is to tie their identity on foss.heptapod.net to a
well-known external one (currently GitHub and Bitbucket are supported):
Georges Racinet's avatar
Georges Racinet committed
40
41
42
43
44
45

In Heptapod, go to your settings, then to the "Account" menu entry. Under
"Social sign-in", if the Bitbucket button displays "Connect", then click it,
you'll be redirected to Bitbucket to review the permissions.
After that you'll be able to log in to Heptapod with your Bitbucket account.

46
47
48
49
50
51
If that is not practical to you, other possibilities include

- email address verification (site administrators can see it, sometimes
  that can be enough)
- well-known GPG key

Georges Racinet's avatar
Georges Racinet committed
52
53
54
55
56
57
58
59
60
61
#### Review the [Heptapod workflow](https://heptapod.net/pages/faq.html#workflow).

As a complement to the FAQ, please also read
[Octobus blog post](https://octobus.net/blog/2019-09-04-heptapod-workflow.html)
for motivation about those choices and what they entail.

Keep in mind that while you are not forced to use topics in principle,
branches for Merge Requests originating from Bitbucket forks will be
[imported as topics](https://dev.heptapod.net/heptapod/heptapod/issues/106).
So it's probably a good idea to activate `evolve` and `topic` if you have some
62
63
of those, even if you don't use `topic` afterwards (see our [Merge Request Quick
Start Guide](https://heptapod.net/pages/quick-start-guide.html)).
Georges Racinet's avatar
Georges Racinet committed
64
65
66
67
68

As the FAQ says, there are settings that can be applied for your projects to
adjust their workflows to your preferences. These are manual administrative
actions that aren't exposed in the web interface. Please get in touch with us
and we'll see what we can do.