Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: publish v8 roadmap #1330

Merged
merged 15 commits into from Sep 8, 2022
13 changes: 13 additions & 0 deletions docs/.vitepress/config.ts
Expand Up @@ -165,6 +165,19 @@ export default defineConfig({
link: '/about/announcements',
items: [
{ text: '2022-01-14', link: '/about/announcements/2022-01-14' },
{ text: '2022-09-08', link: '/about/announcements/2022-09-08' },
],
},
{
text: 'Roadmap',
link: '/about/roadmap/',
items: [
{ text: 'v8 - Make Faker Handier', link: '/about/roadmap/v8' },
{
text: 'v7 - Cleanup and Improvements',
ST-DDT marked this conversation as resolved.
Show resolved Hide resolved
link: '/about/roadmap/v7',
},
{ text: 'v6 - Continue Faker', link: '/about/roadmap/v6' },
],
},
{
Expand Down
26 changes: 26 additions & 0 deletions docs/about/announcements/2022-09-08.md
@@ -0,0 +1,26 @@
---
editLink: false
---

# New Roadmap Published

We haven't made any announcements for a long time, but we are happy to announce that we just published the new roadmap for v8.

Our main focus for v8 is to make Faker more lightweight and flexible.
A huge part of that is better tree shaking support.

Currently, if you just want to generate some reproducible numbers, then you need the entire Faker package.
First, you have to download almost 10MB of data (mostly locales; duplicated for ESM and CJS) and ship half of that (one of them).

We wont tackle the download size for now,
but we hope to reduce the shipped size significantly (deduplicate locale data) on our side and allow your build process discard more unused methods and data.
ST-DDT marked this conversation as resolved.
Show resolved Hide resolved
This should also improve js startup/parse times.

If we are successful, you will only need a few KB of code for numbers and only the locales you need for more complex things such as names.
With a bit of setup on your side you can ship only the parts of the locale data you actually need.
ST-DDT marked this conversation as resolved.
Show resolved Hide resolved
So no more finance data and mime-types, just for a first name.

For more details refer to our roadmap:

- [Roadmap - Overview](../roadmap/index.html)
- [Roadmap v8 - Make Faker Handier](../roadmap/v8.html)
17 changes: 17 additions & 0 deletions docs/about/roadmap/index.md
@@ -0,0 +1,17 @@
---
editLink: false
---

# Roadmap

These pages outline our roadmap for past and future versions.
Click on the specific versions for more details.

## Upcoming Versions

- [v8 - Make Faker Handier](v8.html)

## Previous Versions

- [v7 - Cleanup and Improvements](v7.html)
- [v6 - Continue Faker](v6.html)
70 changes: 70 additions & 0 deletions docs/about/roadmap/v6.md
@@ -0,0 +1,70 @@
---
editLink: false
---

# v6 - Continue Faker

The main task of v6 is fixing technical debts and some cleanup.

## v6.0 - Ensure project foundation

- Rewrite project in TypeScript
- Update dependencies and automate the process
- Add/Extend build pipeline
- Write JSDocs for most of the modules and methods
- Add online documentation/website

[v6.0 Tasks](https://github.com/faker-js/faker/milestone/1)

**Releases**

- [v6.0.0-alpha.0](https://github.com/faker-js/faker/releases/tag/v6.0.0-alpha.0)
- [v6.0.0-alpha.2](https://github.com/faker-js/faker/releases/tag/v6.0.0-alpha.2)
- [v6.0.0-alpha.3](https://github.com/faker-js/faker/releases/tag/v6.0.0-alpha.3)
- [v6.0.0-alpha.4](https://github.com/faker-js/faker/releases/tag/v6.0.0-alpha.4)
- [v6.0.0-alpha.5](https://github.com/faker-js/faker/releases/tag/v6.0.0-alpha.5)
- [v6.0.0-alpha.6](https://github.com/faker-js/faker/releases/tag/v6.0.0-alpha.6)
- [v6.0.0-alpha.7](https://github.com/faker-js/faker/releases/tag/v6.0.0-alpha.7)
- [v6.0.0-beta.0](https://github.com/faker-js/faker/releases/tag/v6.0.0-beta.0)
- [v6.0.0](https://github.com/faker-js/faker/releases/tag/v6.0.0)

## v6.1 - First Bugfixes

- Fix bugs in the implementation and data
- Standardize some method parameters
- Deprecate duplicate methods
- Extend unit tests
- Link missing locales
- Improve documentation

[v6.1 Tasks](https://github.com/faker-js/faker/milestone/2)

**Releases**

- [v6.1.0](https://github.com/faker-js/faker/releases/tag/v6.1.0)
- [v6.1.1](https://github.com/faker-js/faker/releases/tag/v6.1.1)
- [v6.1.2](https://github.com/faker-js/faker/releases/tag/v6.1.2)

## v6.2 - First New Features

- Introduce the first new features
- Add/Update some locales
- More cleanup

[v6.2 Tasks](https://github.com/faker-js/faker/milestone/5)

**Releases**

- [v6.2.0](https://github.com/faker-js/faker/releases/tag/v6.2.0)

## v6.x

Further improvements

- [v6.3 Tasks](https://github.com/faker-js/faker/milestone/7)
- [v6.x Tasks](https://github.com/faker-js/faker/milestone/3)

**Releases**

- [v6.3.0](https://github.com/faker-js/faker/releases/tag/v6.3.0)
- [v6.3.1](https://github.com/faker-js/faker/releases/tag/v6.3.1)
38 changes: 38 additions & 0 deletions docs/about/roadmap/v7.md
@@ -0,0 +1,38 @@
---
editLink: false
---

# v7 - Cleanup and Improvements

In v7 we will remove some methods that we have deprecated in v6 and restructure the sources a bit.
It will be the first release with small breaking changes since we maintain it.

## v7.0 - Structurally Breaking Changes

- Remove deprecations
- Remove faker default export
- Target es2020
- Drop Node v12 support
- Reorganize source folder
- More features

[v7.0 Tasks](https://github.com/faker-js/faker/milestone/8)

**Releases**

- [v7.0.0](https://github.com/faker-js/faker/releases/tag/v7.0.0)
- [v7.0.1](https://github.com/faker-js/faker/releases/tag/v7.0.1)

## v7.x

Further improvements

- [v7.x Tasks](https://github.com/faker-js/faker/milestone/4)

**Releases**

- [v7.1.0](https://github.com/faker-js/faker/releases/tag/v7.1.0)
- [v7.2.0](https://github.com/faker-js/faker/releases/tag/v7.2.0)
- [v7.3.0](https://github.com/faker-js/faker/releases/tag/v7.3.0)
- [v7.4.0](https://github.com/faker-js/faker/releases/tag/v7.4.0)
- [v7.5.0](https://github.com/faker-js/faker/releases/tag/v7.5.0)
35 changes: 35 additions & 0 deletions docs/about/roadmap/v8.md
@@ -0,0 +1,35 @@
---
editLink: false
---

# v8 - Make Faker Handier

Our main goal in v8 is to make Faker more lightweight and more flexible.

## v8.0 - Module Re-Shuffling

Finish the module shuffling.

- Remove locale switching support
- Move String and Number methods into own modules
- Rename Name module to Person
- Rename Address module to Location
- Check modules and methods regarding their name and location
- Try to eliminate circular dependencies in modules
- Standardize function parameters and defaults
- Rewrite image module / providers

[v8.0 Tasks](https://github.com/faker-js/faker/milestone/10)

## v8.1 - Split Faker Class

Split the Faker class into smaller units so you don't have ship an entire locale if you only generate some strings and numbers.
ST-DDT marked this conversation as resolved.
Show resolved Hide resolved

[v8.1 Tasks](https://github.com/faker-js/faker/milestone/11)

## v8.x - Tree-Shakeable Module-Functions

Refactor modules to be tree shakeable.
Potentially allowing individual Faker methods to be called by themselves.

[v8.x Tasks](https://github.com/faker-js/faker/milestone/12)