Skip to content

Commit defb57a

Browse files
Merge branch 'BlackPythonDevs:gh-pages' into master
2 parents 2af3db8 + 00c499d commit defb57a

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

CONTRIBUTING.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,64 @@ Follow these steps and note these guidelines to begin contributing:
66
1. Bug fixes are always welcome. Start by reviewing the [list of bugs](https://github.com/BlackPythonDevs/blackpythondevs.github.io/issues).
77
1. A good way to easily start contributing is to pick and work on a [good first issue](https://github.com/BlackPythonDevs/blackpythondevs.github.io/labels/good%20first%20issue). We try to make these issues as clear as possible and provide basic info on how the code should be changed, and if something is unclear feel free to ask for more information on the issue.
88

9+
# Diagram of infracstructure in use
10+
11+
Below are some diagrams to best explain the file structure of the website, the development structure and how some information are been generated
12+
13+
## Website structure
14+
15+
The diagram below illustrates the main navigation structure of BPD website, showing how the homepage `(Index)` connects to various sections, including the `Home`, `Blog`, `About Us`, `Events`, and `Community`. Each blog article, represented as `Article1` and `Article2`, is linked directly from the `Blog` section.
16+
17+
```mermaid
18+
flowchart TD
19+
Index --> Home
20+
Index --> Blog
21+
Blog --> Article1
22+
Blog --> Article2
23+
Index --> AboutUs
24+
Index --> Events
25+
Index --> Community
26+
```
27+
28+
## Development structure
29+
30+
The diagram below outlines the file structure of the development environment. The root node represents the main directory, containing essential files and folders like `_config.yml`, `_posts`, `_layouts`, `_includes`, `_data`, `_articles`, and `assets`. Each folder contains further organization of specific files. This will aid contributors in understanding how the project is organized and where different components are located.
31+
32+
```mermaid
33+
flowchart TD
34+
root --> _config.yml
35+
root --> _posts/
36+
root --> _layouts/
37+
root --> _includes/
38+
root --> _data/
39+
root --> _articles/
40+
root --> assets/
41+
root --> about.md
42+
root --> index.html
43+
root --> tests/
44+
_posts/ --> post1
45+
_posts/ --> post2
46+
assets/ --> css/
47+
assets/ --> images/
48+
assets/ --> js/
49+
```
50+
51+
## How some information are generated
52+
53+
The diagram below explains how information is generated for the about page, showing how the `about.md`(source content) connects with other contents, templates and configuration files. The `about.md` file links to `_layouts/default.html` and `_includes/header.html` and `footer.html`, which define the page layout and thus generates a `about.html` this html file can be styled and scripted with files in the `assets/` folder. This diagram clarifies the rendering process and how different files work together to create the final output for the about page.
54+
55+
```mermaid
56+
flowchart TD
57+
about.md --> _layouts/default.html
58+
about.md --> _config.yml
59+
_layouts/default.html --> _includes/header.html
60+
_layouts/default.html --> _includes/footer.html
61+
_layouts/default.html --> about.html
62+
_config.yml --> about.html
63+
about.html --> assets/css/style.css
64+
about.html --> assets/js/script.js
65+
```
66+
967
# How to Contribute
1068

1169
## Fork the repository

0 commit comments

Comments
 (0)