Skip to content

Commit eca20a5

Browse files
barredterrabarredterra
committed
docs: split README into separate pages
1 parent 7792c1b commit eca20a5

6 files changed

+114
-102
lines changed

‎README.md

+5-102
Original file line numberDiff line numberDiff line change
@@ -2,108 +2,11 @@
22

33
Datenmanagementsystem des Landesverbands Sächsischer Angler.
44

5-
### Glossary
6-
7-
| German | English | Comment |
8-
|-----------------|-----------------------|-----------|
9-
| Landesverband | State Organization | Root |
10-
| Regionalverband | Regional Organization | 1st Level |
11-
| Verein | Local Organization | 2nd Level |
12-
| Ortsgruppe | Chapter | 3rd Level |
13-
14-
### Installation
15-
16-
#### 1. Create a site
17-
18-
```
19-
bench new-site [site-name] --install-app erpnext
20-
```
21-
22-
#### 2. Complete the setup wizard
23-
24-
Open the browser and complete the setup wizard, for example with the following values:
25-
26-
| Field | Value | Comment |
27-
|----------------------|----------------------------------|---------|
28-
| Language | English | |
29-
| Your Country | Germany | |
30-
| Domains | Non Profit (beta) | |
31-
| Company Name | Landesverband Sächsischer Angler | |
32-
| Company Abbreviation | LV | |
33-
| What does it do? | Landesverband Sächsischer Angler | |
34-
| Bank Name | Default Bank Account | |
35-
| Chart of Accounts | Standard with Numbers | |
36-
37-
38-
#### 3. Install landa
39-
40-
> ERPNext must be already installed and the setup wizard completed before installing landa.
41-
42-
```bash
43-
bench get-app https://github.com/realexperts/landa.git
44-
bench --site [site-name] install-app landa
45-
bench --site [site-name] migrate # currently necessary to get the "Member Count" chart
46-
```
47-
48-
### Reinstallation (developers only)
49-
50-
> **Warning**: all site data will get deleted by the following commands
51-
52-
1. Uninstall landa and reinstall the site
53-
54-
```bash
55-
bench --site [site-name] uninstall-app landa
56-
bench --site [site-name] reinstall
57-
```
58-
59-
2. Open your browser and complete the setup wizard, as described above.
60-
3. Install landa, as described above.
61-
62-
### Data Import with pre-defined IDs
63-
64-
> This section became obsolete with https://github.com/frappe/frappe/pull/15238. Data Import should work out of the box now.
65-
66-
1. Temporarily enable naming by prompt
67-
68-
1. Go to "Customize Form" for the related DocType
69-
2. In the "Naming" section, set autoname to "prompt" and click save
70-
71-
2. Do the data import
72-
3. Manually set the naming series counter to the correct value
73-
74-
a) Open the Regional Orgnaization to update the current number of it's Local Organizations
75-
b) Open Local Organization to Update the current number of it's Chapters or Members
76-
77-
Click on Menu > Update Naming Series
78-
79-
4. Disable naming by prompt
80-
81-
1. Go to "Customize Form" for the related DocType
82-
2. In the "Naming" section, set autoname to "" (empty) and click save
83-
84-
### Create Demo Accounts
85-
86-
With the bench command `make-demo-accounts` you can create a **Member**, **Member Function** and **User** for every existing **Member Function Category**. Just specify an existing local organization:
87-
88-
```
89-
bench --site landa make-demo-accounts AVS-001
90-
```
91-
92-
> The above example uses a site called "landa" and an organization called "AVS-001" as examples. Please replace these with your own values.
93-
94-
### Create a Template Item
95-
96-
1. Open the Item List and click "Add Item"
97-
2. Click "Edit in Full Page"
98-
3. Set the Item Name, for example "Erlaubnisschein"
99-
4. Verify that the correct regional Organization is set in the "Company" field. For example, "Anglerverband Leipzig e. V."
100-
5. Open the section "Variants"
101-
6. Check "Has Variants"
102-
7. Select "Variant Based On" = "Item Attribute"
103-
8. Add the desired attributes to the list. For example, "Erlaubnisscheinart" or "Gültigkeitsjahr"
104-
9. Choose the required Item Tax Template. For example, "Umsatzsteuer 19%"
105-
10. Fill any additional fields (for example, "Description") that should get copied to all variants
106-
11. Click the "Save" button on the top right
5+
- [Installation](docs/installation.md)
6+
- [Organizations and Members](docs/organizations-and-members.md)
7+
- [Permissions](docs/permissions.md)
8+
- [Data Import](docs/data-import.md)
9+
- [Create Demo Accounts](docs/demo-accounts.md)
10710

10811
### API
10912

‎docs/data-import.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Data Import with pre-defined IDs
2+
3+
> This section became obsolete with https://github.com/frappe/frappe/pull/15238. Data Import should work out of the box now.
4+
5+
1. Temporarily enable naming by prompt
6+
7+
1. Go to "Customize Form" for the related DocType
8+
2. In the "Naming" section, set autoname to "prompt" and click save
9+
10+
2. Do the data import
11+
3. Manually set the naming series counter to the correct value
12+
13+
a) Open the Regional Orgnaization to update the current number of it's Local Organizations
14+
b) Open Local Organization to Update the current number of it's Chapters or Members
15+
16+
Click on Menu > Update Naming Series
17+
18+
4. Disable naming by prompt
19+
20+
1. Go to "Customize Form" for the related DocType
21+
2. In the "Naming" section, set autoname to "" (empty) and click save

‎docs/demo-accounts.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
### Create Demo Accounts
2+
3+
This app provide a bench command `make-demo-accounts`. This is useful for testing permissions. You can use it to create a **Member**, **Member Function** and **User** for every existing **Member Function Category**, in an existing local organization.
4+
5+
Prerequisites:
6+
7+
1. Create a [Local Organization](organizations-and-members.md)
8+
2. Define some [Member Function Categories](permissions.md)
9+
10+
Now you can run the following command (replace `$SITE` and `$ORGANIZATION` with your specific values):
11+
12+
```bash
13+
bench --site $SITE make-demo-accounts $ORGANIZATION
14+
```

‎docs/installation.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## 1. Create a site
2+
3+
```
4+
bench new-site [site-name] --install-app erpnext
5+
```
6+
7+
## 2. Complete the setup wizard
8+
9+
Open the browser and complete the setup wizard, for example with the following values:
10+
11+
| Field | Value | Comment |
12+
|----------------------|----------------------------------|---------|
13+
| Language | English | |
14+
| Your Country | Germany | |
15+
| Domains | Non Profit (beta) | |
16+
| Company Name | Landesverband Sächsischer Angler | |
17+
| Company Abbreviation | LV | |
18+
| What does it do? | Landesverband Sächsischer Angler | |
19+
| Bank Name | Default Bank Account | |
20+
| Chart of Accounts | Standard with Numbers | |
21+
22+
23+
## 3. Install landa
24+
25+
> ERPNext must be already installed and the setup wizard completed before installing landa.
26+
27+
```bash
28+
bench get-app https://github.com/realexperts/landa.git
29+
bench --site [site-name] install-app landa
30+
bench --site [site-name] migrate # currently necessary to get the "Member Count" chart
31+
```
32+
33+
## Reinstallation (developers only)
34+
35+
> **Warning**: all site data will get deleted by the following commands
36+
37+
1. Uninstall landa and reinstall the site
38+
39+
```bash
40+
bench --site [site-name] uninstall-app landa
41+
bench --site [site-name] reinstall
42+
```
43+
44+
2. Open your browser and complete the setup wizard, as described above.
45+
3. Install landa, as described above.

‎docs/organizations-and-members.md

+11
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,14 @@ The **LANDA Members** belonging to **Organization** AVL-002-01 will be named lik
6767
- AVL-002-01-0001
6868
- AVL-002-01-0002
6969
- ...
70+
71+
### German terms
72+
73+
| German | English | Comment |
74+
|-------------------|-----------------------|--------------|
75+
| Landesverband | State Organization | Level 0 |
76+
| Regionalverband | Regional Organization | Level 1 |
77+
| Verein | Local Organization | Level 2 |
78+
| Ortsgruppe | Local Group | Level 3 |
79+
| Mitglied | LANDA Member | Level 3 or 4 |
80+
| Mitgliedsfunktion | Member Function | |

‎docs/template-item.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Template Items can be used, for example, for
2+
3+
- fishing permit with attributes "permission type" and "year of validity", or
4+
- membership fees with attributes "membership type" and "year of validity".
5+
6+
To create a Ttmplate Item,
7+
8+
1. Open the Item List and click "Add Item"
9+
2. Click "Edit in Full Page"
10+
3. Set the Item Name, for example "Erlaubnisschein"
11+
4. Verify that the correct regional Organization is set in the "Company" field. For example, "Anglerverband Leipzig e. V."
12+
5. Open the section "Variants"
13+
6. Check "Has Variants"
14+
7. Select "Variant Based On" = "Item Attribute"
15+
8. Add the desired attributes to the list. For example, "Erlaubnisscheinart" or "Gültigkeitsjahr"
16+
9. Choose the required Item Tax Template. For example, "Umsatzsteuer 19%"
17+
10. Fill any additional fields (for example, "Description") that should get copied to all variants
18+
11. Click the "Save" button on the top right

0 commit comments

Comments
 (0)