Skip to content

Commit 4e91e2c

Browse files
m1guelpfm1guelpf
committed
Move to UnMarkDocs
1 parent aefb8ef commit 4e91e2c

23 files changed

+211
-295
lines changed

‎.gitignore

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎README.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎v3.0/documentation/1-OrgManager/0-About OrgManager.md renamed to ‎about.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
excerpt: Everything you need to know about OrgManager
2-
slug: about-orgmanager
1+
---
2+
title: About OrgManager
3+
---
34

45
OrgManager is an open-source project that aims to provide an invite system for GitHub Organizations, but, what does that really mean?
56

‎v3.0/documentation/1-OrgManager/1-Contributing to OrgManager.md renamed to ‎contributing.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
excerpt: There are lots of ways you can contribute to OrgManager. Here you can find a few
2-
slug: contributing-to-orgmanager
1+
---
2+
title: Contributing to OrgManager
3+
---
34

45
**Everyone** can contribute to OrgManager, in either one way or another. Here, you can find a few ways to do it:
56

@@ -26,14 +27,4 @@ You can apply for the sponshorship using the [OrgManager Open Collective](https:
2627

2728
## If you are an influential person (AKA Sharing OrgManager)
2829

29-
It would be awesome if you could share OrgManager in the social networks, especially if your audience is developer-related. You can also upvote us on Product Hunt!
30-
[block:embed]
31-
{
32-
"type": "basic",
33-
"title": "OrgManager",
34-
"html": "<iframe class=\"embedly-embed\" src=\"//cdn.embedly.com/widgets/media.html?src=https%3A%2F%2Fcards.producthunt.com%2Fcards%2Fposts%2F89786%3Fv%3D1&url=https%3A%2F%2Fwww.producthunt.com%2Fposts%2Forgmanager&image=https%3A%2F%2Fph-files.imgix.net%2Fd10a646c-d11d-4552-99fb-33aca6f85dd0%3Fauto%3Dformat%26fit%3Dmax%26h%3D405%26w%3D500&key=02466f963b9b4bb8845a05b53d3235d7&type=text%2Fhtml&schema=producthunt\" width=\"500\" height=\"405\" scrolling=\"no\" frameborder=\"0\" allowfullscreen></iframe>",
35-
"url": "https://www.producthunt.com/posts/orgmanager",
36-
"favicon": "https://assets.producthunt.com/assets/favicon-9247d7de492fd8ec2553739d3635dca4.ico",
37-
"image": "https://ph-files.imgix.net/d10a646c-d11d-4552-99fb-33aca6f85dd0?auto=format&fit=max&h=405&w=500"
38-
}
39-
[/block]
30+
It would be awesome if you could share OrgManager in the social networks, especially if your audience is developer-related. Thanks!

‎development-version/installing.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Installing the OrgManager Developer Version
3+
---
4+
5+
To install the OrgManager Development Version, follow this steps:
6+
7+
## 1. Download beta version
8+
9+
Open your terminal and run
10+
11+
``` bash
12+
git clone https://github.com/orgmanager/orgmanager
13+
```
14+
15+
## 2. Add OrgManager to your server
16+
17+
!!! warning
18+
# This step depends on your server
19+
This step is different depending on the server you use. Normally you can get the process by searching "How to setup Laravel with X" and skipping the laravel install part. Instructions for hotel are provided, as it is the recommended server for development.
20+
!!!
21+
22+
### Setup instructions for [hotel](https://github.com/typicode/hotel):
23+
24+
Open the OrgManager folder with the terminal/console and run
25+
26+
``` bash
27+
hotel add 'php artisan serve --port $PORT'
28+
```
29+
30+
Now, if you configured custom domains, you can now access `orgmanager.{yourtld}`. If you didn't, access `localhost:2000` and click OrgManager. Yeah, it should be showing that error page, don't worry :smile:
31+
32+
## 3. Setup .env
33+
34+
Copy the `.env.example` file to an `.env` file. Open the .env file with your favourite text editor/IDE and fill the database, reCaptcha and GitHub settings (you can leave the rest empty).
35+
36+
## 4. Finish the setup
37+
Open the orgmanager folder with the terminal/console and run
38+
39+
``` bash
40+
composer update
41+
```
42+
and
43+
44+
``` bash
45+
php artisan app:install
46+
```
47+
48+
## 5. Done!
49+
You have now the OrgManager beta version up an running in your server! (Note that OrgManager is not auto-updated, read the updating section for more info).

‎v3.0/documentation/3-Developer Version/0-Requirements.md renamed to ‎development-version/requirements.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
excerpt: This is what your computer needs in order to run the OrgManager Development Version
2-
slug: dev-requirements
1+
---
2+
title: OrgManager Developer Version Requirements
3+
---
34

45
To install and run the OrgManager Development Version, you'll need:
56

‎development-version/testing.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: Testing the OrgManager Development Version
3+
---
4+
5+
We use the Laravel testing functionalities and PHPUnit to add automated testing to OrgManager.
6+
7+
## Setting up the testing enviroment
8+
By default, the tests will run in a special database called `orgmanager_test` in `localhost` with username `root` and password `root`. If you need to change this, edit the `.env.testing` file. This is an example of a customized `.env.testing` file:
9+
10+
``` env
11+
APP_ENV=testing # don't change this!
12+
APP_KEY=base64:GIkaQ57IIVtTeTQOIh7eAFo1FAcoWkfwYPkfcOyusW4= # this is autogenerated
13+
14+
DB_CONNECTION=travis
15+
16+
DB_TEST_HOST=database_host # the testing database host (probably localhost)
17+
DB_TEST_DATABASE=database_name # the testing database name
18+
DB_TEST_USERNAME=database_username # the testing database username
19+
DB_TEST_PASSWORD=database_password # the testing database password
20+
21+
CACHE_DRIVER=array # you shouldn't need to change this
22+
SESSION_DRIVER=array # you shouldn't need to change this
23+
QUEUE_DRIVER=sync # you shouldn't need to change this
24+
```
25+
26+
Once you've customized your .env.testing file, you have to migrate the database to your test database. You can do this by running
27+
28+
``` bash
29+
php artisan migrate --env=testing
30+
```
31+
32+
# Running the tests
33+
To run the tests, run
34+
35+
``` bash
36+
composer test
37+
```

‎development-version/updating.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Updating the OrgManager Development Version
3+
---
4+
5+
To update the OrgManager Development Version, follow this steps:
6+
7+
## Get latest working version of the code
8+
9+
!!! warning
10+
For new releases, remember to check the upgrading guide, if any. You can find it in the [releases page](https://github.com/orgmanager/orgmanager/releases).
11+
!!!
12+
13+
Open the orgmanager folder in the terminal/console and run
14+
``` bash
15+
git pull origin master
16+
```

‎v3.0/documentation/2-Hosted Version/0-About the OrgManager Hosted Version.md renamed to ‎hosted-version/about.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
excerpt: Everything you need to know about the OrgManager Hosted Version
2-
slug: about-the-orgmanager-hosted-version
1+
---
2+
title: About the OrgManager Hosted Version
3+
---
34

45
Not everyone can afford a server, nor do they have the skills to set up a modern PHP application, so OrgManager provides a hosted version you can use **for FREE**. You can access the hosted version at [https://orgmanager.miguelpiedrafita.com](https://orgmanager.miguelpiedrafita.com). In return, please report any bugs you encounter, so we can continue improving!

‎v3.0/documentation/2-Hosted Version/2-The Hosted Version FAQ.md renamed to ‎hosted-version/faq.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
excerpt: Frequently Asked Questions about the OrgManager Hosted Version
2-
slug: the-hosted-version-faq
1+
---
2+
title: Frequently Asked Questions
3+
---
34

45
## Why does OrgManager need admin access to my organization?
56

@@ -17,4 +18,4 @@ Read the [OrgManager Support Channels](doc:orgmanager-support-channels) page.
1718

1819
## Why don't you have a domain name for OrgManager?
1920

20-
I believe the budget for open-source projects should be $0, and since I started OrgManager, I haven't spent anything besides the hosting. If you would like to donate, head over to our [Gratipay](https://gratipay.com/OrgManager) page.
21+
I believe the budget for open-source projects should be $0, and since I started OrgManager, I haven't spent anything besides the hosting. If you would like to donate, head over to our [OpenCollective](https://opencollective.com/orgmanager) page.

‎hosted-version/registering.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: How to register on the OrgManager Hosted Version
3+
---
4+
5+
To register on the OrgManager Hosted Version, follow this simple steps:
6+
7+
## 1. Go to the page
8+
9+
Navigate to the Hosted Version URL ([httos://orgmanager.miguelpiedrafita.com](https://orgmanager.miguelpiedrafita.com)) and click the login button.
10+
11+
## 2. Authorize OrgManager
12+
13+
!!! warning
14+
# Admin Access
15+
OrgManager needs admin access to your organizations to send invites to users and invite users to teams. If you don't have it, please ask your administrator to setup OrgManager for you.
16+
!!!
17+
18+
You'll be redirected to GitHub to complete the registration process. Click the authorize button for every organization you want to use with OrgManager. For more information, you can check the [GitHub support article](https://help.github.com/articles/connecting-with-third-party-applications/).

‎stable-version/installing.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Installing the OrgManager Stable Version
3+
---
4+
5+
To install the OrgManager Stable Version, follow this steps:
6+
7+
## 1. Download latest stable version
8+
9+
Download [the lastest release](https://github.com/orgmanager/orgmanager/releases/latest) and unzip it on your server.
10+
11+
## 2. Add OrgManager to your server
12+
13+
!!! warning
14+
# This step depends on your server
15+
This step is different depending on the server you use. Normally you can get the process by searching "How to setup Laravel with X" and skipping the laravel install part.
16+
!!!
17+
18+
If you try to access OrgManager at his step, it should show an error. Don't worry :smile:
19+
20+
## 3. Setup .env
21+
22+
Copy the `.env.example` file to an `.env` file. Open the .env file with your favourite text editor/IDE and fill the database, reCaptcha and GitHub settings. (You can leave the rest as they are, although it is recommended setting up [Sentry](https://sentry.io/) in production).
23+
24+
!!! warning
25+
# Remember to disable debug mode!
26+
Remember to set `DEBUG` to `false` and `APP_ENV` to `prod`.
27+
!!!
28+
29+
## 4. Finish the setup
30+
31+
Open the OrgManager folder with the terminal/console and run
32+
33+
``` bash
34+
composer update
35+
```
36+
and
37+
38+
``` bash
39+
php artisan app:install
40+
```
41+
42+
## 5. Done!
43+
You have now the latest OrgManager stable version up and running in your server! (Note that OrgManager is not auto-updated, read the updating section for more info).

‎v3.0/documentation/4-Stable version/0-Requirements.md renamed to ‎stable-version/requirements.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
excerpt: This is what your computer needs in order to run the OrgManager Stable Version
2-
slug: prod-requirements
1+
---
2+
title: OrgManager Stable Version Requirements
3+
---
34

45
To install and run the OrgManager Stable Version, you'll need:
56

‎stable-version/updating.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Updating the OrgManager Stable Version
3+
---
4+
5+
To update the OrgManager Stable Version, follow this steps:
6+
7+
## Download latest stable version
8+
9+
Download the [lastest release](https://github.com/orgmanager/orgmanager/releases/latest) and unzip it on your server, replacing if asked.
10+
11+
## Follow the upgrade guide
12+
13+
Some releases will include an upgrade guide. You can check in the [releases page](https://github.com/orgmanager/orgmanager/releases).

‎v3.0/documentation/1-OrgManager/2-OrgManager Support Channels.md renamed to ‎support.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
excerpt: OrgManager provides some official ways to get support, chat or learn more.
2-
slug: orgmanager-support-channels
1+
---
2+
title: OrgManager Support Channels
3+
---
34

45
Although a documentation is provided, we are humans, and humans like to talk to each other. They also have unique problems. To keep humans happy (:smile:) you can contact us in a variety of ways, to troubleshoot your problem, suggest a new feature, help on the project or just to say hi.
56

‎v3.0/documentation/1-OrgManager/3-People.md renamed to ‎thanks.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,19 @@
1-
excerpt: Meet the people that have made this possible
2-
slug: people
1+
---
2+
title: People
3+
---
34

45
People are the most important part of the code. OrgManager was created to solve a problem, but since then, it has grown into something bigger, and everything was made possible thanks those listed below.
5-
[block:api-header]
6-
{
7-
"title": "Authors"
8-
}
9-
[/block]
6+
7+
## Authors
108
* [Miguel Piedrafita](https://miguelpiedrafita.com) is the main developer of OrgManager. He started the project and has coded almost everything.
119
* [Elio Qoshi](https://elioqoshi.me) designed the OrgManager Branding. We have to thank him for that cool blue tone.
1210
* [Afnizar Nur Ghifari](https://afnizarnur.com) is working in the frontend redesign. OrgManager will look awesome soon thanks to him.
1311
- Obviously, the best thing of Open Source is that anyone can help the project, in one way or another. You can see a list of all the people that collaborated on [GitHub](https://github.com/orgmanager/orgmanager/contributors).
14-
[block:api-header]
15-
{
16-
"title": "Acknowledgments"
17-
}
18-
[/block]
12+
13+
## Acknowledgments
1914
* [Laracasts](https://laracasts.com/), [StackOverflow](https://stackoverflow.com) & [The Laravel Community](https://laravel.com) have helped from the first commit.
2015
* [Simon Vansintjan](http://simon.vansintjan.net) and [Jan-Christoph Borchardt](http://jancborchardt.net) provided the first feedback and suggested some core-features.
2116
* [Taylor Otwell](https://github.com/taylorotwell) & [Rasmus Lerdorf](http://lerdorf.com/bio/) created [Laravel](https://laravel.com) & [PHP](https://php.net) respectively.
22-
[block:api-header]
23-
{
24-
"title": "Backers"
25-
}
26-
[/block]
17+
18+
## Backers
2719
You can see a list of our backers on the [OrgManager OpenCollective](https://opencollective.com/orgmanager)

‎v3.0/documentation/2-Hosted Version/3-Joining the OrgManager Organization.md renamed to ‎the-orgmanager-org.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
excerpt: Learn how to join the OrgManager Organizaion on GitHub
2-
slug: joining-the-orgmanager-organization
1+
---
2+
title: Joining the OrgManager GitHub org
3+
---
34

45
You know a software is good when the members of the project solve that problem with it. At OrgManager we use OrgManager to invite users to our organization, and everyone can join!
56
Just access the [OrgManager OrgManager's page](https://orgmanager.miguelpiedrafita.com/o/orgmanager) :wink: and enter your GitHub username to recieve an invite!

‎v3.0/documentation/2-Hosted Version/1-Registering on the OrgManager Hosted Version.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

0 commit comments

Comments
 (0)