Skip to content

Commit ae03bf5

Browse files
[ Rewrite ] Websites Overview (#144)
* Rewrote websites overview * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Revert "[pre-commit.ci] auto fixes from pre-commit.com hooks" This reverts commit 3d929f0. * Exclude markdown in pre-commit plugin * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 87ca7b0 commit ae03bf5

File tree

3 files changed

+111
-34
lines changed

3 files changed

+111
-34
lines changed

.pre-commit-config.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ repos:
1313
rev: v6.0.0
1414
hooks:
1515
- id: trailing-whitespace
16+
args: [--markdown-linebreak-ext=md]
1617
- id: end-of-file-fixer
1718
- id: check-yaml
1819
- id: check-added-large-files

technical/Websites.md

Lines changed: 109 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,64 +2,140 @@
22
layout: default
33
---
44

5-
# Contributing to FreeCAD websites
5+
# Websites
66

7-
Technical information for contributors interested to work on FreeCAD websites.
7+
FreeCAD has a multitude of websites for various purposes.
88

9-
## The Ecosystem
9+
<br/>
1010

11-
Currently, the websites infrastructure of FreeCAD consists of the following :
11+
## Hosted
1212

13-
- [The FreeCAD website](https://www.freecad.org) acts as the main entry point into FreeCAD's universe for all users, contributors and interested parties.
13+
The following websites are directly hosted by FreeCAD.
1414

15-
- [The News Blog](https://blog.freecad.org/) brings together development news, tutorials and use cases from the community.
15+
<br/>
1616

17-
- [The Wiki](https://wiki.freecad.org/) gathers all the documentation about FreeCAD, from usage to installation, development, release notes and much more. Historically, this has been the all-purpose place for all FreeCAD-related matters. A more development-oriented portion of it has been migrated to this Developer Handbook.
17+
### Homepage
1818

19-
- [The Developer Handbook](https://freecad.github.io/DevelopersHandbook/) is the very site you are currently in.
19+
[![Page]][Page-Homepage]
20+
[![Repo]][Repo-Homepage]
2021

21-
- [The Forum](https://forum.freecad.org/) is one of the many places where the community meets and exchanges.
22+
This is the entry point for everything FreeCAD.
2223

23-
- [The FreeCAD Project Association website](https://fpa.freecad.org/) groups everything that relates to the association overseeing the FreeCAD project.
24+
The backend is built with [PHP], the frontend uses
25+
[Bootstrap] & [jQuery] as well as [Font Awesome].
2426

25-
In addition to the implemented websites listed above, several external platforms are used :
27+
*[≫ How to contribute][Contribute-Homepage]*
2628

27-
- [The Repositories](https://github.com/FreeCAD) of FreeCAD main codebase, building and packaging, continuous integration, addons, macros, library, websites and more are on GitHub.
29+
<br/>
2830

29-
- [The Translations](https://crowdin.com/project/freecad) of the software interface and the main website are on Crowdin.
31+
### Blog
3032

31-
Moreover, here are the current implementation initiatives not yet used :
33+
[![Page]][Page-Blog]
3234

33-
- [The FreeCAD Documentation](https://freecad-documentation.netlify.app/) overhaul as part of the GSOC 2023
35+
Reports on new releases, tutorials
36+
and use cases from the community.
3437

35-
## Technical details
38+
The page is based on [WordPress].
3639

37-
### FreeCAD website
40+
<br/>
3841

39-
The website mainly uses HTML/PHP, CSS, the Bootstrap and jQuery JavaScript libraries, the Font Awesome toolkit.\
40-
To contribute to the main website, find [here a few advices and resources](./FreeCADweb.md).
42+
### Wiki
4143

42-
### News Blog
44+
[![Page]][Page-Wiki]
45+
[![Repo]][Repo-Wiki]
4346

44-
The News Blog is based on WordPress.\
45-
<!-- To contribute to the blog, find here a few advices and resources. TODO: contact Chennes, ConcreteDog and Alex -->
47+
Aggregation of FreeCAD knowledge, mostly
48+
user documentation, with development info
49+
continually migrating to other system.
4650

47-
### Wiki
51+
The page is based on [MediaWiki].
52+
53+
<br/>
54+
55+
### Handbook
4856

49-
The News Blog is based on MediaWiki.\
50-
<!-- To contribute to the wiki, find here a few advices and resources. TODO: contact wiki team -->
57+
[![Page]][Page-Handbook]
58+
[![Repo]][Repo-Handbook]
5159

52-
### Developer Handbook
60+
Documentation for developers,
61+
focused mostly on FreeCAD Core.
5362

54-
The Developer Handbook uses Jekyll, a Ruby static site generator, and Markdown.\
55-
To contribute to the Developer Handbook, find [here a few advices and resources](./DevBook.md).
63+
The page is built using [Jekyll]
64+
and written in simple Markdown.
65+
66+
*[≫ How to contribute][Contribute-Handbook]*
67+
68+
<br/>
5669

5770
### Forum
5871

59-
The News Blog is based on phpBB.\
60-
<!-- To contribute to the Forum, find here a few advices and resources. TODO: contact forum team -->
72+
[![Page]][Page-Forum]
73+
74+
Community exchange structured using
75+
boards and posts to communicate.
76+
77+
The page is based on [phpBB].
78+
79+
<br/>
80+
81+
### FPA
82+
83+
[![Page]][Page-FPA]
84+
[![Repo]][Repo-FPA]
85+
86+
Everything relating to the project
87+
association that oversees the FreeCAD.
88+
89+
The page is built using [Jekyll]
90+
and written in simple Markdown.
91+
92+
*[≫ How to contribute][Contribute-FPA]*
93+
94+
<br/>
95+
96+
## Employed
97+
98+
The following websites are hosted by platforms.
99+
100+
### [GitHub][Page-GitHub]
101+
102+
Hosts most of source code and
103+
assets of the FreeCAD project.
104+
105+
### [Crowdin][Page-Crowdin]
106+
107+
Translation platform used for the FreeCAD
108+
app and homepage as well as some addons.
109+
110+
<br/>
111+
112+
113+
[Contribute-Handbook]: ./DevBook
114+
[Contribute-Homepage]: ./FreeCADweb
115+
[Contribute-FPA]: ./FPAweb
116+
117+
[Repo-Handbook]: https://github.com/FreeCAD/DevelopersHandbook
118+
[Repo-Homepage]: https://github.com/FreeCAD/FreeCAD-Homepage
119+
[Repo-Wiki]: https://github.com/Reqrefusion/FreeCAD-Documentation-Project
120+
[Repo-FPA]: https://github.com/FreeCAD/FPA
121+
122+
[Page-Handbook]: https://freecad.github.io/DevelopersHandbook
123+
[Page-Homepage]: https://freecad.org
124+
[Page-Crowdin]: https://crowdin.com/project/freecad
125+
[Page-GitHub]: https://github.com/FreeCAD
126+
[Page-Forum]: https://forum.freecad.org
127+
[Page-Blog]: https://blog.freecad.org
128+
[Page-Wiki]: https://wiki.freecad.org
129+
[Page-FPA]: https://fpa.freecad.org
61130

62-
### FreeCAD Project Association website
131+
[Font Awesome]: https://fontawesome.com
132+
[Bootstrap]: https://getbootstrap.com
133+
[WordPress]: https://wordpress.org
134+
[MediaWiki]: https://mediawiki.org
135+
[Jekyll]: https://jekyllrb.com
136+
[jQuery]: https://jquery.com
137+
[phpBB]: https://www.phpbb.com
138+
[PHP]: https://www.php.net
63139

64-
The FreeCAD Project Association website also uses Jekyll, a Ruby static site generator, and Markdown.\
65-
To contribute to the FreeCAD Project Association website, find [here a few advices and resources](./FPAweb.md).
140+
[Repo]: https://img.shields.io/badge/Repository-181717?style=flat&logo=GitHub&logoColor=white
141+
[Page]: https://img.shields.io/badge/Website-418FDE?style=flat&logo=FreeCAD&logoColor=white

technical/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Technical information of interest to Contributors.
3030
- [Coin3d](https://www.coin3d.org/): a [scenegraph](https://wiki.freecad.org/Scenegraph) manager based on OpenInventor that handles drawing in the 3d window.
3131
- [Pivy](https://wiki.freecad.org/Pivy): a Python binding for Coin3d
3232

33-
- [Contributing to FreeCAD websites](./Websites.md)
33+
- [Websites](./Websites)
3434

3535
- [Reference Library](./ReferenceLibrary.md)
3636

0 commit comments

Comments
 (0)