Skip to content

Commit

Permalink
chore: change the repo name from "universe" to "core" (#2379)
Browse files Browse the repository at this point in the history
  • Loading branch information
zhoushaw authored Apr 25, 2024
1 parent d42d492 commit e019b57
Show file tree
Hide file tree
Showing 37 changed files with 1,492 additions and 1,492 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ body:
label: Validations
description: Before submitting the issue, please make sure you do the following
options:
- label: Read the [docs](https://github.com/module-federation/universe).
- label: Read the [docs](https://github.com/module-federation/core).
required: true
- label: Read the [common issues list](https://github.com/module-federation/universe/issues).
- label: Read the [common issues list](https://github.com/module-federation/core/issues).
required: true
- label: Check that there isn't [already an issue](https://github.com/module-federation/universe/issues) that reports the same bug to avoid creating a duplicate.
- label: Check that there isn't [already an issue](https://github.com/module-federation/core/issues) that reports the same bug to avoid creating a duplicate.
required: true
- label: Make sure this is a Module federation issue and not a framework-specific issue.
required: true
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Questions & Discussions
url: https://github.com/module-federation/universe/discussions
url: https://github.com/module-federation/core/discussions
about: Use GitHub discussions for message-board style questions and discussions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ body:
label: Validations
description: Before submitting the issue, please make sure you do the following
options:
- label: Read the [Contributing Guidelines](https://github.com/module-federation/universe/blob/canary/CONTRIBUTING.md).
- label: Read the [Contributing Guidelines](https://github.com/module-federation/core/blob/canary/CONTRIBUTING.md).
required: true
- label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
required: true
2 changes: 1 addition & 1 deletion .github/workflows/issue-close-require.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
permissions:
issues: write
runs-on: ubuntu-latest
if: github.repository == 'module-federation/universe'
if: github.repository == 'module-federation/core'
steps:
- name: need reproduction
uses: actions-cool/issues-helper@v3
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/issue-labeled.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:

jobs:
reply-labeled:
if: github.repository == 'module-federation/universe'
if: github.repository == 'module-federation/core'
runs-on: ubuntu-latest
steps:
- name: contribution welcome
Expand Down
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ If you've changed some packages, you need add a new changeset for the changes. P
pnpm run changeset
```

![image](https://github.com/module-federation/universe/assets/27547179/15505abf-8b0b-450f-b2d0-ffdc52e710a4)
![image](https://github.com/module-federation/core/assets/27547179/15505abf-8b0b-450f-b2d0-ffdc52e710a4)


### Committing your Changes
Expand Down Expand Up @@ -138,7 +138,7 @@ Module Federation uses GitHub Actions for automated versioning and publishing:
2. Make sure that both "use workflow from" and "release branch" are split for the test version you want to release
3. Use the "next" TAB to release the test version

![image](https://github.com/module-federation/universe/assets/27547179/f84fd796-d1d9-42f6-8bb2-95b07c6d7749)
![image](https://github.com/module-federation/core/assets/27547179/f84fd796-d1d9-42f6-8bb2-95b07c6d7749)



Expand All @@ -147,15 +147,15 @@ Module Federation uses GitHub Actions for automated versioning and publishing:
1. Use the release pull request to release an official version
* It will create a pull request that includes the changed version

![image](https://github.com/module-federation/universe/assets/27547179/b5ed83f3-4cf8-4a95-859b-729e3ad0e7eb)
![image](https://github.com/module-federation/universe/assets/27547179/1cfc2e71-dbf9-41d8-84f8-3948eb636c7c)
![image](https://github.com/module-federation/core/assets/27547179/b5ed83f3-4cf8-4a95-859b-729e3ad0e7eb)
![image](https://github.com/module-federation/core/assets/27547179/1cfc2e71-dbf9-41d8-84f8-3948eb636c7c)



2. If the version is normal, release it using release workflow and then a branch of pull request
![image](https://github.com/module-federation/universe/assets/27547179/5c66e9e5-7bd7-4466-a1aa-38420f1dac82)
![image](https://github.com/module-federation/core/assets/27547179/5c66e9e5-7bd7-4466-a1aa-38420f1dac82)


4. Generate a release note based on the original tag after the release is complete

![image](https://github.com/module-federation/universe/assets/27547179/accc9626-9ffd-4074-8d47-14372ae77400)
![image](https://github.com/module-federation/core/assets/27547179/accc9626-9ffd-4074-8d47-14372ae77400)
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img alt="Module federation Banner" width="260" src="https://github.com/module-federation/universe/assets/27547179/11234712-40fc-4696-a7fd-16e0c631005a">
<img alt="Module federation Banner" width="260" src="https://github.com/module-federation/core/assets/27547179/11234712-40fc-4696-a7fd-16e0c631005a">
</p>

# Module Federation
Expand Down Expand Up @@ -39,13 +39,13 @@ Some of the underlying dependencies of the past are listed here, and [enhanced](

# 🧑‍💻 Community

Come and chat with us on [Discussions](https://github.com/module-federation/universe/discussions)! The Module federation team and users are active there, and we're always looking for contributions.
Come and chat with us on [Discussions](https://github.com/module-federation/core/discussions)! The Module federation team and users are active there, and we're always looking for contributions.

# 🤝 Contribution

> New contributors welcome!
Please read the [Contributing Guide](https://github.com/module-federation/universe/blob/main/CONTRIBUTING.md).
Please read the [Contributing Guide](https://github.com/module-federation/core/blob/main/CONTRIBUTING.md).

# Credits

Expand Down
14 changes: 7 additions & 7 deletions apps/docs/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,18 @@ Before you begin, make sure you have the following installed on your machine:
- nx
- yarn
You also need a GitHub account and a fork of the https://github.com/module-federation/universe[module-federation/universe] repository.
You also need a GitHub account and a fork of the https://github.com/module-federation/core[module-federation/core] repository.

## Setting up your environment

Documentation website consists of 2 applications:

- `docs-ui` holds the visual part of the documentation website. When serving\building the docs app, docs-ui will be prebuilt as its dependency.
- `docs` is the one that is meant to contain all the actual documentation.
- `docs` is the one that is meant to contain all the actual documentation.
To set up your environment, follow these steps:

1. Clone your fork of the module-federation/universe repository to your local machine.
1. Clone your fork of the module-federation/core repository to your local machine.
2. Navigate to the `apps/docs` folder inside the cloned repository.
3. Run `npm install` to install the dependencies.
4. By default, serving\building will pull the changes from the `main` branch. To use it, run `nx run docs:serve`. Along with it there's a `local` configuration, that provides an ability to rely on the files within the filesystem. Can be used by running `nx run docs:serve:local`
Expand All @@ -44,20 +44,20 @@ To make changes to the documentation, follow these steps:
## Submitting pull requests

Once you are happy with your changes, you can submit a pull request to the module-federation/universe repository. A pull request is a way of proposing your changes to be merged into the main branch of the repository.
Once you are happy with your changes, you can submit a pull request to the module-federation/core repository. A pull request is a way of proposing your changes to be merged into the main branch of the repository.

To submit a pull request, follow these steps:

1. Commit your changes to your local branch using `git commit -m "your message"`.
2. Push your changes to your remote fork using `git push origin your-branch`.
3. Go to https://github.com/module-federation/universe and click on "New pull request".
3. Go to https://github.com/module-federation/core and click on "New pull request".
4. Select your fork and branch as the source and the main branch as the destination.
5. Fill in the title and description of your pull request and click on "Create pull request".
Your pull request will be reviewed by the maintainers of the `module-federation/universe` repository as well as by a technical writer who will check your content for accuracy, clarity, and adherence to Google Developers Documentation Style Guide. The technical writer may suggest some changes or improvements to your content before merging it to the main branch. and they will provide feedback or approve it.
Your pull request will be reviewed by the maintainers of the `module-federation/core` repository as well as by a technical writer who will check your content for accuracy, clarity, and adherence to Google Developers Documentation Style Guide. The technical writer may suggest some changes or improvements to your content before merging it to the main branch. and they will provide feedback or approve it.

## Conclusion

That's it! You have successfully contributed to the Module Federation documentation! Thank you for your time and effort!

If you have any questions or issues, feel free to reach out to us on https://github.com/module-federation/universe/discussions[GitHub Discussions]
If you have any questions or issues, feel free to reach out to us on https://github.com/module-federation/core/discussions[GitHub Discussions]
4 changes: 2 additions & 2 deletions apps/website-new/docs/en/community/v0-1.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> April 3, 2024
We have recently released the **v0.1** version of **[Module Federation Enhanced](https://github.com/module-federation/universe)** (You can simply think of it as the early version of Module Federation 2.0.)!
We have recently released the **v0.1** version of **[Module Federation Enhanced](https://github.com/module-federation/core)** (You can simply think of it as the early version of Module Federation 2.0.)!

`Module Federation Enhanced` differs from the `Module Federation` built into `Webpack5` by providing not only the core features of module export, loading, and dependency sharing but also additional dynamic type hinting, `Manifest`, `Federation Runtime`, and `Runtime Plugin`. These features make `Module Federation` more suitable for use as a micro-frontend architecture in large-scale `Web` applications.

Expand Down Expand Up @@ -30,4 +30,4 @@ At the same time, we will offer more framework-level capabilities, such as: `Mod

### 🙏 Acknowledgements

The release of `Module Federation Enhanced` version `0.1` would not have been possible without the feedback and suggestions from the `Module Federation` community and the efforts of contributors to the [`Universe`](https://github.com/module-federation/universe) repository.
The release of `Module Federation Enhanced` version `0.1` would not have been possible without the feedback and suggestions from the `Module Federation` community and the efforts of contributors to the [`Universe`](https://github.com/module-federation/core) repository.
2 changes: 1 addition & 1 deletion apps/website-new/docs/en/guide/framework/nextjs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ class MyDocument extends Document {
## For Express.js
Hot reloading Express.js required additional steps: https://github.com/module-federation/universe/blob/main/packages/node/README.md
Hot reloading Express.js required additional steps: https://github.com/module-federation/core/blob/main/packages/node/README.md
## Whats shared by default?
Expand Down
4 changes: 2 additions & 2 deletions apps/website-new/docs/zh/community/v0-1.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> April 3, 2024
我们最近发布了 **[Module Federation enhanced](https://github.com/module-federation/universe)** **v0.1** 版本(你可以简单将其理解为 Module Federation 2.0 的早期版本)!
我们最近发布了 **[Module Federation enhanced](https://github.com/module-federation/core)** **v0.1** 版本(你可以简单将其理解为 Module Federation 2.0 的早期版本)!

`Module Federation Enhanced` 不同于 `Webpack5` 内置的 `Module Federation` 它提供了除 `Module Federation` 有的:模块导出、模块加载、依赖共享,还提供了额外的动态类型提示、`Manifest``Federation Runtime``Runtime Plugin`,这些功能能让 `Module Federation` 更适合作为大型 `Web` 应用的微前端架构。

Expand Down Expand Up @@ -32,4 +32,4 @@

### 🙏 致谢

`Module Federation Enhanced``0.1` 发布离不开 `Module Federation` 的反馈和建议、 [`Universe`](https://github.com/module-federation/universe) 仓库贡献者做出的努力。
`Module Federation Enhanced``0.1` 发布离不开 `Module Federation` 的反馈和建议、 [`Universe`](https://github.com/module-federation/core) 仓库贡献者做出的努力。
4 changes: 2 additions & 2 deletions apps/website-new/rspress.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,14 @@ export default defineConfig({
],
editLink: {
docRepoBaseUrl:
'https://github.com/module-federation/universe/tree/main/apps/website-new/docs',
'https://github.com/module-federation/core/tree/main/apps/website-new/docs',
text: 'Edit this page on GitHub',
},
socialLinks: [
{
icon: 'github',
mode: 'link',
content: 'https://github.com/module-federation/universe',
content: 'https://github.com/module-federation/core',
},
],
},
Expand Down
2 changes: 1 addition & 1 deletion apps/website-new/theme/components/HomeFooter/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ function useFooterData() {
items: [
{
title: 'GitHub',
link: 'https://github.com/module-federation/universe',
link: 'https://github.com/module-federation/core',
},
// {
// title: 'Discord',
Expand Down
2 changes: 1 addition & 1 deletion apps/website/src/components/sections/evolving/evolving.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export default component$(() => {
),
actionText: t('evolving.rfcs.action@@Take part now!'),
actionHref:
'https://github.com/module-federation/universe/discussions/categories/rfc',
'https://github.com/module-federation/core/discussions/categories/rfc',
target: '_blank' as ButtonPropsTarget,
lineClass:
'absolute w-24 bottom-[5%] md:bottom-[20%] left-full -translate-x-full',
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"build": "nx run-many --target=build --parallel=3 --exclude='*,!tag:type:pkg'",
"build:pkg": "nx run-many --targets=build --projects=tag:type:pkg",
"lint-fix": "nx format:write --uncommitted",
"trigger-release": "node -e 'import(\"open\").then(open => open.default(\"https://github.com/module-federation/universe/actions/workflows/trigger-release.yml\"))'",
"trigger-release": "node -e 'import(\"open\").then(open => open.default(\"https://github.com/module-federation/core/actions/workflows/trigger-release.yml\"))'",
"serve:next": "nx run-many --target=serve --all --parallel=3 -exclude='*,!tag:nextjs'",
"serve:website": "nx run website-new:serve",
"build:website": "nx run website-new:build",
Expand Down
Loading

0 comments on commit e019b57

Please sign in to comment.