Skip to content

Commit a9fa159

Browse files
yeehaa123yeehaa123
committed
add contribution and roadmap folders
1 parent b542ae2 commit a9fa159

6 files changed

Lines changed: 122 additions & 163 deletions

File tree

‎packages/documentation/public/brand-identity.md‎

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

packages/documentation/public/product-roadmap/intro.md renamed to packages/documentation/public/feature-roadmap/about.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
# Product roadmap
1+
Curious to know what features you can help us develop?
22

3-
Curious to know what features you can help us develop?
3+
You will see on our roadmap that there are a lot of opportunities to expand the functionalities of the platform, both the functionality of the course cards as well as navigation on the platform for example.
4+
We continuously update our product roadmap with new features.
45

5-
You will see on our roadmap that there are a lot of opportunities to expand the functionalities of the platform, both the functionality of the course cards as well as navigation on the platform for example.
6-
We continuously update our product roadmap with new features.
7-
8-
We are also open to discuss features you would like to work on that are not on our roadmap. You can get in touch via [email](mailto:contact@offcourse.io) to discuss the possibilities.
6+
We are also open to discuss features you would like to work on that are not on our roadmap. You can get in touch via [email](mailto:contact@offcourse.io) to discuss the possibilities.

packages/documentation/public/how-to-contribute/intro.md renamed to packages/documentation/public/how-to-contribute/about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
In this section you will find all the information you need before starting your contribution to Offcourse. This includes the contributing guidelines and the work ethos we aspire as a community.
22

3-
If anything is unclear, you can have a look at the [FAQ](https://www.offcourse.io/faq) on the Offcourse website, or contact the maintainers of this website via contact@offcourse.io.
3+
If anything is unclear, you can have a look at the [FAQ](https://www.offcourse.io/faq) on the Offcourse website, or contact the maintainers of this website via [contact@offcourse.io](contact@offcourse.io).

‎packages/documentation/public/how-to-contribute/contributing-guidelines.md‎

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
1-
# Contributing Guidelines
2-
31
👍🎉 First off, thanks for taking the time to contribute! 🎉👍
42

53
The following is a set of guidelines for contributing to the further development of the Offcourse platform, which is hosted on the [Offcourse-Next GitHub repo](https://github.com/OffCourse/offcourse-next). All fundamentals for design, coding and the work ethos of the Offcourse community can be found seperately at ...
64

75
## Table Of Contents
86

9-
* Code of Conduct
10-
* What should I know before I get started?
11-
* How Can I Contribute?
12-
* Reporting Bugs
13-
* Suggesting Enhancements
14-
* Contributing changes (Bug fixes, Code Contribution and Pull Requests)
7+
- Code of Conduct
8+
- What should I know before I get started?
9+
- How Can I Contribute?
10+
- Reporting Bugs
11+
- Suggesting Enhancements
12+
- Contributing changes (Bug fixes, Code Contribution and Pull Requests)
1513

1614
## Code of Conduct
1715

@@ -27,9 +25,9 @@ JavaScript, on the other hand, has moved in the opposite direction. There is an
2725

2826
If you are interested in contributing to our open source project, you can make a contribution by one of the following:
2927

30-
* Reporting Bugs
31-
* Suggesting Enhancements
32-
* Contributing changes (Bug fixes, Code Contributions and Pull Requests)
28+
- Reporting Bugs
29+
- Suggesting Enhancements
30+
- Contributing changes (Bug fixes, Code Contributions and Pull Requests)
3331

3432
## Reporting Bugs
3533

@@ -39,35 +37,35 @@ The Offcourse platform is under continuous development. Bugs are a natural part
3937

4038
Make sure your report gets the attention it deserves: bug reports with missing information may be ignored or punted back to you, delaying a fix. The below constitutes a bare minimum; more info is almost always better:
4139

42-
* **A detailed description of the bug**. Describe how the bug occurred, what action you took when it happened. Also, include print screens.
43-
* **What version of the core programming language interpreter/compiler you are using.**
44-
* **What operating system you are on.** Windows? (Vista? 7? 32-bit? 64-bit?) Mac OS X? (10.7.4? 10.9.0?) Linux? (Which distro? Which version of that distro? 32 or 64 bits?) Again, more detail is better.
45-
* **Which version or versions of the software you are using.** Ideally, you followed the advice above and have ruled out (or verified that the problem exists in) a few different versions.
40+
- **A detailed description of the bug**. Describe how the bug occurred, what action you took when it happened. Also, include print screens.
41+
- **What version of the core programming language interpreter/compiler you are using.**
42+
- **What operating system you are on.** Windows? (Vista? 7? 32-bit? 64-bit?) Mac OS X? (10.7.4? 10.9.0?) Linux? (Which distro? Which version of that distro? 32 or 64 bits?) Again, more detail is better.
43+
- **Which version or versions of the software you are using.** Ideally, you followed the advice above and have ruled out (or verified that the problem exists in) a few different versions.
4644

4745
## Suggesting enhancements
4846

4947
Feature requests and Design Change Requests (DCRs) are an important part of the lifecycle of any software project. Please log these as Issues in the GitHub repository. Again, please provide us with the necessary information so we, and other community members, understand the value of the request. This includes:
5048

51-
* Detailed scenarios enabled by the feature or DCR.
52-
* Information about your use case or additional value you / your business will see from the feature.
53-
* Any design tips or estimation ideas you may have considered already.
54-
* Make note of whether you are opening an issue you would like the Offcourse team or another community member to work on *or* if you are looking to design & develop the feature yourself.
55-
* Any potential caveats or concerns you may have already thought about.
56-
* A miniature test plan or list of test scenarios is always helpful.
49+
- Detailed scenarios enabled by the feature or DCR.
50+
- Information about your use case or additional value you / your business will see from the feature.
51+
- Any design tips or estimation ideas you may have considered already.
52+
- Make note of whether you are opening an issue you would like the Offcourse team or another community member to work on *or* if you are looking to design & develop the feature yourself.
53+
- Any potential caveats or concerns you may have already thought about.
54+
- A miniature test plan or list of test scenarios is always helpful.
5755

5856
## Contributing changes
5957

6058
This constitutes bug fixing as well as the contribution to a new feature from our roadmap and code contribution in general. You will find our bug database and roadmap soon to see what contributions can be made here. The following are guidelines for working on such changes.
6159

62-
Before you start working on a feature or substantial code contribution that is not in our bug database or on our roadmap, please discuss it with the team and ensure it is an appropriate addition to the core product. You can do this by sending an email to contact@offcourse.io.
60+
Before you start working on a feature or substantial code contribution that is not in our bug database or on our roadmap, please discuss it with the team and ensure it is an appropriate addition to the core product. You can do this by sending an email to [contact@offcourse.io](contact@offcourse.io)
6361

6462
## **Version control branching**
6563

66-
* Always **make a new branch** for your work, no matter how small. This makes it easy for others to take just that one set of changes from your repository, in case you have multiple unrelated changes floating around.
64+
- Always **make a new branch** for your work, no matter how small. This makes it easy for others to take just that one set of changes from your repository, in case you have multiple unrelated changes floating around.
6765

6866
> A corollary: don’t submit unrelated changes in the same branch/pull request! The maintainer shouldn’t have to reject your awesome bugfix because the feature you put in with it needs more review.
6967
70-
* **Base your new branch off of the appropriate branch** on the main repository:
68+
- **Base your new branch off of the appropriate branch** on the main repository:
7169

7270
Bug fixes should be based on the branch named after the oldest supported release line the bug affects.
7371

‎packages/documentation/src/App.js‎

Lines changed: 3 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,8 @@
11
import React, { Component } from "react";
2-
import * as atoms from "@offcourse/atoms";
3-
import * as molecules from "@offcourse/molecules";
4-
import * as organisms from "@offcourse/organisms";
5-
import { Catalog, pageLoader } from "catalog";
2+
import pages from "./pages";
3+
import { Catalog } from "catalog";
64
import { offcourse } from "./themes";
75

8-
const baseUrl = `https://github.com/OffCourse/offcourse-next/tree/master/packages/atoms/src/`;
9-
10-
const createPages = ({ name: collectionName, blocks, helpers }) => {
11-
const pageNames = Object.keys(blocks);
12-
return pageNames.map(blockName => ({
13-
imports: {
14-
...blocks,
15-
...helpers,
16-
meta: {
17-
blockName,
18-
collectionName,
19-
url: baseUrl + blockName
20-
}
21-
},
22-
path: `/${collectionName}/${blockName}`,
23-
title: `${blockName}`,
24-
content: pageLoader(`/${collectionName}/${blockName}.md`)
25-
}));
26-
};
27-
286
const { fonts, grayScale } = offcourse;
297

308
const catalogTheme = {
@@ -41,43 +19,7 @@ class App extends Component {
4119
title="Documentation"
4220
theme={catalogTheme}
4321
useBrowserHistory={true}
44-
pages={[
45-
{
46-
path: "/",
47-
title: "General Introduction",
48-
content: pageLoader("./general-introduction.md")
49-
},
50-
{
51-
path: "/visual-identity",
52-
title: "Visual Identity",
53-
imports: {
54-
...offcourse.colors,
55-
grayScale: offcourse.namedGrayScale
56-
},
57-
content: pageLoader("./visual-identity.md")
58-
},
59-
{
60-
title: "Atoms",
61-
pages: createPages({
62-
name: "atoms",
63-
blocks: atoms
64-
})
65-
},
66-
{
67-
title: "Molecules",
68-
pages: createPages({
69-
name: "molecules",
70-
blocks: molecules
71-
})
72-
},
73-
{
74-
title: "Organisms",
75-
pages: createPages({
76-
name: "organisms",
77-
blocks: organisms
78-
})
79-
}
80-
]}
22+
pages={pages}
8123
/>
8224
);
8325
}

‎packages/documentation/src/pages.js‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
import { pageLoader } from "catalog";
2+
import * as atoms from "@offcourse/atoms";
3+
import * as molecules from "@offcourse/molecules";
4+
import * as organisms from "@offcourse/organisms";
5+
import { offcourse } from "./themes";
6+
7+
const baseUrl = `https://github.com/OffCourse/offcourse-next/tree/master/packages/atoms/src/`;
8+
9+
const createPages = ({ name: collectionName, blocks, helpers }) => {
10+
const pageNames = Object.keys(blocks);
11+
return pageNames.map(blockName => ({
12+
imports: {
13+
...blocks,
14+
...helpers,
15+
meta: {
16+
blockName,
17+
collectionName,
18+
url: baseUrl + blockName
19+
}
20+
},
21+
path: `/${collectionName}/${blockName}`,
22+
title: `${blockName}`,
23+
content: pageLoader(`/${collectionName}/${blockName}.md`)
24+
}));
25+
};
26+
27+
const pages = [
28+
{
29+
path: "/",
30+
title: "General Introduction",
31+
content: pageLoader("./general-introduction.md")
32+
},
33+
{
34+
path: "/how-to-contribute",
35+
title: "How To Contribute",
36+
pages: [
37+
{
38+
path: "/how-to-contribute/about",
39+
title: "About",
40+
content: pageLoader("/how-to-contribute/about.md")
41+
},
42+
{
43+
path: "/how-to-contribute/contributing-guidelines",
44+
title: "Contributing Guidelines",
45+
content: pageLoader("/how-to-contribute/contributing-guidelines.md")
46+
}
47+
]
48+
},
49+
{
50+
path: "/feature-roadmap",
51+
title: "Feature Roadmap",
52+
pages: [
53+
{
54+
path: "/feature-roadmap/about",
55+
title: "About",
56+
content: pageLoader("/feature-roadmap/about.md")
57+
}
58+
]
59+
},
60+
{
61+
path: "/visual-identity",
62+
title: "Visual Identity",
63+
imports: {
64+
...offcourse.colors,
65+
grayScale: offcourse.namedGrayScale
66+
},
67+
content: pageLoader("./visual-identity.md")
68+
},
69+
{
70+
title: "Atoms",
71+
pages: createPages({
72+
name: "atoms",
73+
blocks: atoms
74+
})
75+
},
76+
{
77+
title: "Molecules",
78+
pages: createPages({
79+
name: "molecules",
80+
blocks: molecules
81+
})
82+
},
83+
{
84+
title: "Organisms",
85+
pages: createPages({
86+
name: "organisms",
87+
blocks: organisms
88+
})
89+
}
90+
];
91+
92+
export default pages;

0 commit comments

Comments
 (0)