Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
….org into patch-1
  • Loading branch information
Reza Rahmati committed Jan 5, 2024
2 parents f7bb605 + 72c890b commit 35ac647
Show file tree
Hide file tree
Showing 1,796 changed files with 53,912 additions and 28,642 deletions.
File renamed without changes.
43 changes: 11 additions & 32 deletions .github/workflows/build_deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,50 +6,29 @@ on:
- master
pull_request:
branches:
- "*"
- '*'

jobs:
build:
name: Build Docusaurus
build_and_deploy:
name: Build & deploy
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 16.x
cache: yarn
cache-dependency-path: website/yarn.lock
node-version: 16
cache: 'npm'
- name: Build website
working-directory: website
run: |
yarn install --frozen-lockfile
yarn build
deploy:
name: Deploy to GitHub Pages
if: github.ref == 'refs/heads/master' && github.repository_owner == 'single-spa'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 16.x
cache: yarn
cache-dependency-path: website/yarn.lock
- name: Build website
working-directory: website
run: |
yarn install --frozen-lockfile
yarn build
# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
npm ci
npm run build
- name: Deploy to GitHub Pages
if: github.ref == 'refs/heads/master' && github.repository_owner == 'single-spa'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
publish_dir: ./website/build
publish_dir: ./build
# Assign commit authorship to the official GH-Actions bot for deploys to `gh-pages` branch:
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
# The GH actions bot is used by default if you didn't specify the two fields.
Expand Down
21 changes: 21 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,22 @@
# dependencies
/node_modules

# production
/build

# generated files
.docusaurus
.cache-loader

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*

static/.circleci
53 changes: 21 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,43 @@
# single-spa.js.org

This repo contains the source code and documentation powering [single-spa.js.org](https://single-spa.js.org).
This repo contains the source code and documentation powering [single-spa.js.org](https://single-spa.js.org). Powered by [Docusaurus](https://docusaurus.io/).

## Getting started
## Prerequisites

### Prerequisites
1. git
1. node >=16.14
1. [your fork](https://github.com/single-spa/single-spa.js.org/fork) of this repo

1. Git
1. Node: install version 8.4 or greater
1. Yarn: See [Yarn website for installation instructions](https://yarnpkg.com/lang/en/docs/install/)
1. A fork of the repo (for any contributions)
1. A clone of the [single-spa.js.org repo](https://github.com/single-spa/single-spa.js.org) on your local machine
## Installation

### Installation
1. `git clone [email protected]:<your-fork-of>/single-spa.js.org.git`
1. `cd single-spa.js.org` to go into the website root
1. `npm i` to install dependencies

1. `git clone [email protected]:single-spa/single-spa.js.org.git`
1. `cd single-spa.js.org/website` to go into the website root
1. `yarn` to install the website's npm dependencies
## Running locally

### Running locally

1. `cd website` then run `yarn start` to start the hot-reloading development server (powered by [Docusaurus](https://docusaurus.io/))
1. run `npm start` to start the hot-reloading development server
1. `open http://localhost:3000` to open the site in your favorite browser
- Changes to files in `src/` will hot-reload
- Changes to markdown files in `docs/` will hot-reload
- Changes to `docusaurus.config.js` and `sidebars.json` will not hot-reload

## Contributing

Want to help improve the `single-spa.js.org` website? Checkout the steps below to learn how.

### Create a branch

1. `git checkout master` from any folder in your local `single-spa.js.org` repository
1. `git pull origin master` to ensure you have the latest main code
1. `git checkout -b the-name-of-my-branch` (replacing `the-name-of-my-branch` with a suitable name) to create a branch

### Make the change

1. Save the files and check in the browser
1. Changes to files in `website/pages/en` will hot-reload
1. Changes to markdown files in `docs` will hot-reload
1. Changes to `siteConfig.js` and `sideBards.json` will not hot-reload
1. `git switch -c descriptive-branch-name`

### Test the change
Test visual changes using any number of latest versions of common browsers, on both desktop and mobile

1. If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile.

### Push it
### Contribute!

1. `git add . && git commit -m "My message"` (replacing `My message` with a commit message, such as `Fixed header logo`) to stage and commit your changes
1. `git push my-fork-name the-name-of-my-branch`
1. Go to the [single-spa.js.org repo](https://github.com/single-spa/single-spa.js.org) and you should see recently pushed branches.
1. Follow GitHub's instructions.
1. If possible, include screenshots of visual changes.

1. Go to the upstream [single-spa.js.org repo](https://github.com/single-spa/single-spa.js.org) and you should see recently pushed branches.
1. Create a pull request describing the changes
- If possible, include screenshots of visual changes.
1. (Optional) Post your PR in the #maintainers channel of the Slack workspace
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ While you are verifying that everything is working, keep in mind that each appli

Conclusion

As you get your feet wet, you’ll probably run into some (hopefully small) hiccups setting things up. When this tutorial is not enough, there are other resources on [Github](https://github.com/single-spa/single-spa) and here in the [docs](docs/building-applications.html).
As you get your feet wet, you’ll probably run into some (hopefully small) hiccups setting things up. When this tutorial is not enough, there are other resources on [Github](https://github.com/single-spa/single-spa) and here in the [docs](/docs/building-applications).

Single-spa is still a relatively new thing, and we’d love to hear your feedback and questions. We welcome contributions from everyone.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ We’d love to get your feedback on parcels. What do you think of this new way o
Check out the [official docs](https://github.com/single-spa/single-spa/blob/master/docs/parcels.md) for more examples, explanations, and [api documentation](https://github.com/single-spa/single-spa/blob/master/docs/parcels-api.md).
And let us know your thoughts in the [single-spa Slack channel](https://join.slack.com/t/single-spa/shared_invite/zt-15a59134l-ytK9bWMD1z3vGTC9LwPREg), a [Github issue](https://github.com/single-spa/single-spa/issues), or [on Twitter](https://twitter.com/Single_spa)!
And let us know your thoughts in the [single-spa Slack channel](https://join.slack.com/t/single-spa/shared_invite/zt-21skfl7l3-leF7JkoKwKaRIPX~N6jXJQ), a [Github issue](https://github.com/single-spa/single-spa/issues), or [on Twitter](https://twitter.com/Single_spa)!
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -92,4 +92,4 @@ This change does not mean anything drastic for single-spa. Its license was and i

We are actively [translating the single-spa documentation to Chinese](https://github.com/single-spa/zh-hans.single-spa.js.org), and hope to add other languages soon. We will add full [Angular 9 support](https://github.com/single-spa/single-spa-angular/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+angular+9) soon, and hope to add [server rendering](https://github.com/single-spa/single-spa/issues/103) in an upcoming release.

Please [contribute to our code](/docs/contributing-overview) and [ecosystem](/docs/ecosystem), [join our single-spa slack channel](https://join.slack.com/t/single-spa/shared_invite/zt-15a59134l-ytK9bWMD1z3vGTC9LwPREg), [follow our official Twitter account](https://twitter.com/Single_spa), and contribute to [our open collective](https://opencollective.com/single-spa). The [single-spa core team](/contributors) all have full-time jobs and maintain this project on a volunteer basis.
Please [contribute to our code](/docs/contributing-overview) and [ecosystem](/docs/ecosystem), [join our single-spa slack channel](https://join.slack.com/t/single-spa/shared_invite/zt-21skfl7l3-leF7JkoKwKaRIPX~N6jXJQ), [follow our official Twitter account](https://twitter.com/Single_spa), and contribute to [our open collective](https://opencollective.com/single-spa). The [single-spa core team](/contributors) all have full-time jobs and maintain this project on a volunteer basis.
13 changes: 13 additions & 0 deletions blog/2023-08-22-single-spa-core-is-expanding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# The single-spa core team is expanding

We are happy to announce that the single-spa core team is opening applications for two new members! As a core team member, you will help us maintain and guide the growing single-spa ecosystem by responding to Github and Slack issues, implementing new features, and helping to create the roadmap for the future of single-spa.

Our current core team consists of Joel Denning, Carlos Filoteo, and Anthony Frehner. We also thank Justin McMurdie and Bret Little for their valuable contributions during their time with the single-spa core team.

Single-spa owes its success to the people and companies who support it. If you want to contribute but aren’t able to join the core team, consider applying to be a maintainer. Maintainers are volunteers who receive Github write access to specific subprojects within the ecosystem. If you’re a manager at a company that uses single-spa, we encourage you to allow your developers to volunteer their time as maintainers or core team members so that the project can continue to grow and develop.

The single-spa core team and maintenance are unpaid volunteer positions. Looking ahead, if any core team members or maintainers are interested in new paid roles, Convex Cooperative (the company Joel works for) will be considering hiring new developers from the single-spa team. It’s important to state that Convex will not poach developers away from companies who allow their developers to help us maintain single-spa—our priority is nurturing the growth and development of the single-spa ecosystem.

If interested in applying to be a single-spa maintainer or core team member, please fill out the following Google Form before September 1, 2023:

[https://docs.google.com/forms/d/1zIfP2kYjNBCi-qjKf9T1-sNT1VLSXTB9twwX_mxKYxU/edit](https://docs.google.com/forms/d/1zIfP2kYjNBCi-qjKf9T1-sNT1VLSXTB9twwX_mxKYxU/edit)
23 changes: 23 additions & 0 deletions blog/2023-10-11-introducing-single-spa-new-core-team-members.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Introducing Single-Spa's New Core Team Members

Please welcome the latest additions to the Single-Spa core team. These talented individuals bring fresh energy and a wealth of expertise and are poised to revitalize and expand the Single-Spa project.

## Meet the Team

**[Artur Androsovych](https://github.com/arturovt)**

Artur Androsovych is a Google Developer Expert in Angular and an open-source contributor who has been focusing on runtime performance and teaching teams about Angular internals for the past few years. He has maintained the single-spa-angular project for years, and we're excited for him to join the core team.

**[Roberto Mosca](https://github.com/robmosca)**

Roberto is a Principal Software Engineer at TravelPerk (www.travelperk.com), where he is the go-to person for all things related to their frontend platform. With a full-stack background, he's got his hands on a variety of tech — from Python to NodeJS, React, Webpack... Before diving into the world of business travel, he was immersed in biomedical research as a bioinformatician. When he is not in front of a screen, you’ll find him swimming, cooking up some Italian delicacies, or tinkering with his Rubik’s cube-solving robots.

**[Milan Kovacic](https://github.com/MilanKovacic)**

Milan Kovacic is a seasoned software consultant with deep expertise in various development domains. On the frontend side, his work is marked by proficiency in React, TypeScript, and the integration of microfrontends. For backend solutions, he mostly relies on the .NET framework, C#—often utilizing microservices architecture. Additionally, Milan is experienced with cloud technologies, regularly working with platforms like AWS and Azure. Beyond traditional development, he places great emphasis on ensuring a smooth developer experience and promotes the use of automation and efficient DevOps practices to streamline development workflows.

These three new members will be joining current members Joel Denning, Carlos Filoteo, and Anthony Frehner to manage GitHub and Slack issues and actively develop new features. We’d also like to give special recognition to contributors from Qiankun for their extensive support over the years.

As part of this team update, we’ll also be creating a public roadmap, providing transparency about Single-Spa's future direction. To maintain transparency and encourage collaboration, we're establishing monthly meetings where the core team will discuss progress, challenges, and ideas. Meeting notes will be publicly available, ensuring that the community is well-informed and able to participate in our discussions.

So stay tuned and join us on this journey shaping the future of microfrontends.
32 changes: 32 additions & 0 deletions blog/2023-11-07-core-team-meeting-notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# November 2023 Core Team Meeting

Attendees: Joel Denning, Milan Kovacic, Jake Hayes

## November 2023 Roadmap

1. Release `single-spa@6` as latest
2. Consolidate and update the example projects

## Meeting Notes

- Open pull requests, pressing Github issues
- We reviewed https://github.com/single-spa/single-spa-react/pull/197
- Core team vacancy
- Add Jake Hayes to the #core-team channel, but not officially a core team member
- Joel will reach out to Ian about joining the core team.
- Single-spa roadmap
- Maintenance update/plan

## Roadmap Brainstorm
- Adding unit tests to existing projects
- SystemJS -> ESM migration
- create-single-spa update (https://github.com/cruft/cruft)
- Release single-spa 6 as latest
- Improve shared dependencies management
- Autopublishes to npm
- Server rendering enhancements?
- Support for NextJS, NuxtJS, Remix, create-react-app, and other build tools
- Consolidate example projects
- Feature voting
- Automated integration tests for popular frameworks
- Update create-single-spa dependencies
Loading

0 comments on commit 35ac647

Please sign in to comment.