Skip to content

Commit 544d8a3

Browse files
tjbutzlpgarzonr
andauthored
Docu Structure (#42)
* Update docusaurus.config.ts * Updated docu structure * Update introduction.mdx * Improve Legal Disclosure link * Add founded information * First WIP version for installations * Update concepts.mdx * Update introduction.mdx * Add periods and favicon * Improve getting started * Improve getting started * clean up * Update package-lock.json * gettingStarted: add the delete step * Add more prerequisites so the users can start openmfp wothout any problem * Add info for preview version * Improve the contributing section * fix home layout * more on contribute * Add key features * Improve the installation scripts with the new findings * Add community section * Fix discussions link * add code of conduct from the community repo --------- Co-authored-by: Leidy Garzon <[email protected]>
1 parent b634854 commit 544d8a3

39 files changed

+1795
-1059
lines changed

blog/2019-05-28-first-blog-post.md

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

blog/2019-05-29-long-blog-post.md

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

blog/2021-08-01-mdx-blog-post.mdx

Lines changed: 0 additions & 24 deletions
This file was deleted.
-93.9 KB
Binary file not shown.

blog/2021-08-26-welcome/index.md

Lines changed: 0 additions & 29 deletions
This file was deleted.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
slug: introducing-openmfp
3+
title: Introducing OpenMFP
4+
authors: [tino, leidy]
5+
tags: [openmfp]
6+
---
7+
8+
## Introducing OpenMFP: Simplifying Micro Frontends Platforms 🌐🚀
9+
10+
We're excited to unveil OpenMFP (Open Micro Frontend Platform), a powerful framework designed for building enterprise-level web applications and portals.
11+
12+
**OpenMFP** streamlines UI integration by allowing teams to work autonomously while seamlessly connecting their services. It features a dynamic extension model, centralized shared services (like authentication), and a flexible control plane for easy management across various teams and technologies. 🛠️
13+
14+
### Key Features 🏆
15+
* Centralized Authentication & Authorization
16+
* Unified Frontend Portal
17+
* Extensible Control Plane
18+
* Customizable Permission Models
19+
20+
OpenMFP enables seamless service integration, improves user experience, and ensures teams can develop, release, and maintain their capabilities independently. Ready to simplify your micro frontend architecture? ✨ check our [documentation](./docs/).
21+

blog/authors.yml

Lines changed: 49 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,53 @@
1-
yangshun:
2-
name: Yangshun Tay
3-
title: Front End Engineer @ Facebook
4-
url: https://github.com/yangshun
5-
image_url: https://github.com/yangshun.png
1+
tino:
2+
name: Tino Butz
3+
title: Product Owner
4+
url: https://github.com/tjbutz
5+
image_url: https://github.com/tjbutz.png
66
page: true
77
socials:
8-
x: yangshunz
9-
github: yangshun
8+
github: tjbutz
109

11-
slorber:
12-
name: Sébastien Lorber
13-
title: Docusaurus maintainer
14-
url: https://sebastienlorber.com
15-
image_url: https://github.com/slorber.png
16-
page:
17-
# customize the url of the author page at /blog/authors/<permalink>
18-
permalink: '/all-sebastien-lorber-articles'
10+
bastian:
11+
name: Bastian Echterhölter
12+
title: Software Architect
13+
url: https://github.com/nexus49
14+
image_url: https://github.com/nexus49.png
15+
page: true
16+
socials:
17+
github: nexus49
18+
19+
tobias:
20+
name: Tobias Oetzel
21+
title: Software Developer
22+
url: https://github.com/tobias-oetzel
23+
image_url: https://github.com/tobias-oetzel.png
24+
page: true
25+
socials:
26+
github: tobias-oetzel
27+
28+
leidy:
29+
name: Leidy Garzón Rodriguez
30+
title: Software Engineer
31+
url: https://github.com/lpgarzonr
32+
image_url: https://github.com/lpgarzonr.png
33+
page: true
34+
socials:
35+
github: lpgarzonr
36+
37+
aaron:
38+
name: Aaron Schweig
39+
title: Software Engineer
40+
url: https://github.com/aaronschweig
41+
image_url: https://github.com/aaronschweig.png
42+
page: true
43+
socials:
44+
github: aaronschweig
45+
46+
valentin:
47+
name: Valentin Zipf
48+
title: Software Engineer
49+
url: https://github.com/vzipf
50+
image_url: https://github.com/vzipf.png
51+
page: true
1952
socials:
20-
x: sebastienlorber
21-
linkedin: sebastienlorber
22-
github: slorber
23-
newsletter: https://thisweekinreact.com
53+
github: vzipf

blog/tags.yml

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,5 @@
1-
facebook:
2-
label: Facebook
3-
permalink: /facebook
4-
description: Facebook tag description
1+
openmfp:
2+
label: OpenMFP
3+
permalink: ./onepmfp
4+
description: OpenMFP link
55

6-
hello:
7-
label: Hello
8-
permalink: /hello
9-
description: Hello tag description
10-
11-
docusaurus:
12-
label: Docusaurus
13-
permalink: /docusaurus
14-
description: Docusaurus tag description
15-
16-
hola:
17-
label: Hola
18-
permalink: /hola
19-
description: Hola tag description

docs/community.mdx

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
sidebar_position: 4
3+
---
4+
5+
# Community
6+
7+
The OpenMFP community is the heart of our platform's development. We believe in fostering an inclusive, collaborative environment where users, developers, and contributors can work together to improve OpenMFP. Whether you're using OpenMFP, contributing code, or exploring the platform, we encourage you to engage with us.
8+
9+
## GitHub Discussions
10+
11+
We have enabled [GitHub Discussions](https://github.com/orgs/openmfp/discussions). This is a space where you can connect with other users, ask questions, and share feedback about OpenMFP.
12+
13+
### How to Participate:
14+
15+
- **Ask questions**: Get help, share your challenges, or learn best practices.
16+
- **Share ideas**: Suggest features, enhancements, or improvements to the platform.
17+
- **Report issues**: Discuss bugs or behaviors before reporting them officially.
18+
- **Collaborate**: Engage with other developers, contributors, and users to help shape the future of OpenMFP.
19+
20+
### Community Code of Conduct
21+
22+
We strive to maintain a respectful and inclusive environment. Please follow our [Code of Conduct](https://github.com/openmfp/community/blob/main/CODE_OF_CONDUCT.md) when engaging with the community.
23+
24+
By participating, you agree to foster a positive, collaborative, and welcoming space for everyone.
25+
26+
## Stay Updated
27+
28+
- **Read the Blog**: Stay informed about **new features, updates** [here](/blog).
29+
- **Engage on GitHub Discussions**: Join the conversation and collaborate with the community.
30+
31+

docs/concepts.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Concepts
6+
7+
8+
Modern cloud platforms and enterprise cloud services are highly modular consist of many individual components that are developed autonomously. The quality of the complete solution and user experience depends on the quality of integration.
9+
10+
We have moved away from monolithic architectures towards a composition of solution capabilities. This is true for a decoupled architecture from a single provider with micro services, as well as for service mesh approaches involving different providers. Both scenarios call for micro frontends to support the need of composition on the user interface layer.
11+
12+
The Open Micro Frontend Platform (OpenMFP) aims to provide the opinionated, “batteries-included” platform for micro frontend architecture, enabling a well integrated, state of the art end user experience.
13+
14+
The inclusion of a central ReBAC service (relationship based access control) addresses the important need of having a seamless user and permission management that supports the same extensibility and modularity for access control, removing friction from scenarios that span multiple components.

0 commit comments

Comments
 (0)