|
2 | 2 | layout: default
|
3 | 3 | ---
|
4 | 4 |
|
5 |
| -# Contributing to FreeCAD websites |
| 5 | +# Websites |
6 | 6 |
|
7 |
| -Technical information for contributors interested to work on FreeCAD websites. |
| 7 | +FreeCAD has a multitude of websites for various purposes. |
8 | 8 |
|
9 |
| -## The Ecosystem |
| 9 | +<br/> |
10 | 10 |
|
11 |
| -Currently, the websites infrastructure of FreeCAD consists of the following : |
| 11 | +## Hosted |
12 | 12 |
|
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. |
14 | 14 |
|
15 |
| -- [The News Blog](https://blog.freecad.org/) brings together development news, tutorials and use cases from the community. |
| 15 | +<br/> |
16 | 16 |
|
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 |
18 | 18 |
|
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] |
20 | 21 |
|
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. |
22 | 23 |
|
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]. |
24 | 26 |
|
25 |
| -In addition to the implemented websites listed above, several external platforms are used : |
| 27 | +*[≫ How to contribute][Contribute-Homepage]* |
26 | 28 |
|
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/> |
28 | 30 |
|
29 |
| -- [The Translations](https://crowdin.com/project/freecad) of the software interface and the main website are on Crowdin. |
| 31 | +### Blog |
30 | 32 |
|
31 |
| -Moreover, here are the current implementation initiatives not yet used : |
| 33 | +[![Page]][Page-Blog] |
32 | 34 |
|
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. |
34 | 37 |
|
35 |
| -## Technical details |
| 38 | +The page is based on [WordPress]. |
36 | 39 |
|
37 |
| -### FreeCAD website |
| 40 | +<br/> |
38 | 41 |
|
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 |
41 | 43 |
|
42 |
| -### News Blog |
| 44 | +[![Page]][Page-Wiki] |
| 45 | +[![Repo]][Repo-Wiki] |
43 | 46 |
|
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. |
46 | 50 |
|
47 |
| -### Wiki |
| 51 | +The page is based on [MediaWiki]. |
| 52 | + |
| 53 | +<br/> |
| 54 | + |
| 55 | +### Handbook |
48 | 56 |
|
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] |
51 | 59 |
|
52 |
| -### Developer Handbook |
| 60 | +Documentation for developers, |
| 61 | +focused mostly on FreeCAD Core. |
53 | 62 |
|
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/> |
56 | 69 |
|
57 | 70 | ### Forum
|
58 | 71 |
|
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 |
61 | 130 |
|
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 |
63 | 139 |
|
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 |
0 commit comments