Skip to content

Commit

Permalink
chore: rename v2.docusaurus.io urls after domain switch + redirect + …
Browse files Browse the repository at this point in the history
…cleanups (#4490)

* prepare v1-v2 domain switch

* rename v1 changelog as CHANGELOG-1.x.md

* switch v1/v2 changelogs

* Cleanup v2.docusaurus.io urls

* add netlify domain redirect

* remove circleci config

* remove another circle file
  • Loading branch information
slorber authored Mar 22, 2021
1 parent aaea266 commit 7834948
Show file tree
Hide file tree
Showing 73 changed files with 109 additions and 217 deletions.
104 changes: 0 additions & 104 deletions .circleci/config.yml

This file was deleted.

2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2955,7 +2955,7 @@ If you are still encountering the error. Please check whether you use `module.ex
- Add missing dependencies on `@docusaurus/preset-classic`
- New plugin `@docusaurus/plugin-ideal-image` to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder)
- Better Twitter/discord image preview. Previously the size is too zoomed
- Allow prism syntax highlighting theme customization. Refer to https://v2.docusaurus.io/docs/markdown-features#syntax-highlighting
- Allow prism syntax highlighting theme customization. Refer to https://docusaurus.io/docs/markdown-features#syntax-highlighting
- CSS is now autoprefixed using postcss
- Faster, lighter webpack bundle size
- `@docusaurus/theme-live-codeblock` is now much smaller in size and no longer only load on viewport
Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to Docusaurus

[Docusaurus](https://docusaurus.io) is our way to hopefully help to create open source documentation easier. We currently have [multiple open source projects using it](https://v2.docusaurus.io/showcase), with many more planned. If you're interested in contributing to Docusaurus, hopefully, this document makes the process for contributing clear.
[Docusaurus](https://docusaurus.io) is our way to hopefully help to create open source documentation easier. We currently have [multiple open source projects using it](https://docusaurus.io/showcase), with many more planned. If you're interested in contributing to Docusaurus, hopefully, this document makes the process for contributing clear.

The [Open Source Guides](https://opensource.guide/) website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source alike will find the following guides especially useful:

Expand All @@ -15,10 +15,10 @@ Facebook has adopted a Code of Conduct that we expect project participants to ad

There are many ways to contribute to Docusaurus, and many of them do not involve writing any code. Here's a few ideas to get started:

- Simply start using Docusaurus. Go through the [Getting Started](https://v2.docusaurus.io/docs/installation) guide. Does everything work as expected? If not, we're always looking for improvements. Let us know by [opening an issue](#reporting-new-issues).
- Simply start using Docusaurus. Go through the [Getting Started](https://docusaurus.io/docs/installation) guide. Does everything work as expected? If not, we're always looking for improvements. Let us know by [opening an issue](#reporting-new-issues).
- Look through the [open issues](https://github.com/facebook/docusaurus/issues). Provide workarounds, ask for clarification, or suggest labels. Help [triage issues](#triaging-issues-and-pull-requests).
- If you find an issue you would like to fix, [open a pull request](#your-first-pull-request). Issues tagged as [_Good first issue_](https://github.com/facebook/docusaurus/labels/Good%20first%20issue) are a good place to get started.
- Read through the [Docusaurus docs](https://v2.docusaurus.io/docs/installation). If you find anything that is confusing or can be improved, you can make edits by clicking "Edit" at the top of most docs.
- Read through the [Docusaurus docs](https://docusaurus.io/docs/installation). If you find anything that is confusing or can be improved, you can make edits by clicking "Edit" at the top of most docs.
- Take a look at the [features requested](https://github.com/facebook/docusaurus/labels/enhancement) by others in the community and consider opening a pull request if you see something you want to work on.

Contributions are very welcome. If you think you need help planning your contribution, please ping us on Twitter at [@docusaurus](https://twitter.com/docusaurus) and let us know you are looking for a bit of help.
Expand All @@ -27,8 +27,8 @@ Contributions are very welcome. If you think you need help planning your contrib

If you only want to make content changes you just need to know about versioned docs.

- `website/docs` - The files in here are responsible for the "next" version at https://v2.docusaurus.io/docs/next/installation.
- `website/versioned_docs/version-X.Y.Z` - These are the docs for the X.Y.Z version at https://v2.docusaurus.io/docs/X.Y.Z/installation.
- `website/docs` - The files in here are responsible for the "next" version at https://docusaurus.io/docs/next/installation.
- `website/versioned_docs/version-X.Y.Z` - These are the docs for the X.Y.Z version at https://docusaurus.io/docs/X.Y.Z/installation.

To make a fix to the published versions you must edit the corresponding markdown file in both folders. If you only made changes in `docs`, be sure to be viewing the `next` version to see the updates (ensure there's `next` in the URL).

Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@
<a href="https://meercode.io/facebook/docusaurus"><img src="https://meercode.io/badge/facebook/docusaurus?type=ci-score" alt="CI Score"></a>
</p>

> **We are working hard on Docusaurus v2. If you are new to Docusaurus, try using the new version instead of v1. See the [Docusaurus v2 website](https://v2.docusaurus.io/) for more details.**
> **We are working hard on Docusaurus v2. If you are new to Docusaurus, try using the new version instead of v1. See the [Docusaurus v2 website](https://docusaurus.io/) for more details.**
> Docusaurus v1 doc is available at [v1.docusaurus.io](https://v1.docusaurus.io)
> Docusaurus v1 doc is available at [v1.docusaurus.io](https://v1.docusaurus.io)
Expand All @@ -31,15 +33,15 @@ Docusaurus is a project for building, deploying, and maintaining open source pro

- **Simple to Start**

> Docusaurus is built in a way so that it can [get running](https://v2.docusaurus.io/docs/installation) in as little time as possible. We've built Docusaurus to handle the website build process so you can focus on your project.
> Docusaurus is built in a way so that it can [get running](https://docusaurus.io/docs/installation) in as little time as possible. We've built Docusaurus to handle the website build process so you can focus on your project.
- **Localizable**

> Docusaurus ships with [localization support](https://v2.docusaurus.io/docs/i18n/introduction) via CrowdIn. Empower and grow your international community by translating your documentation.
> Docusaurus ships with [localization support](https://docusaurus.io/docs/i18n/introduction) via CrowdIn. Empower and grow your international community by translating your documentation.
- **Customizable**

> While Docusaurus ships with the key pages and sections you need to get started, including a home page, a docs section, a [blog](https://v2.docusaurus.io/docs/blog), and additional support pages, it is also [customizable](https://v2.docusaurus.io/docs/creating-pages) as well to ensure you have a site that is [uniquely yours](https://v2.docusaurus.io/docs/styling-layout).
> While Docusaurus ships with the key pages and sections you need to get started, including a home page, a docs section, a [blog](https://docusaurus.io/docs/blog), and additional support pages, it is also [customizable](https://docusaurus.io/docs/creating-pages) as well to ensure you have a site that is [uniquely yours](https://docusaurus.io/docs/styling-layout).
## Installation

Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-init/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Create Docusaurus apps easily.

## Usage

Please see the [installation documentation](https://v2.docusaurus.io/docs/installation).
Please see the [installation documentation](https://docusaurus.io/docs/installation).
2 changes: 1 addition & 1 deletion packages/docusaurus-init/templates/bootstrap/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Website

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

### Installation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ author_image_url: https://avatars1.githubusercontent.com/u/17883920?s=460&v=4
tags: [hello, docusaurus]
---

Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://v2.docusaurus.io/).
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://docusaurus.io/).

<!--truncate-->

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ You can use our blog plugin to do your posts

<!--truncate-->

If you want add your own component, you can use the `swizzle` command. Check more at our [doc](https://v2.docusaurus.io/docs/using-themes#swizzling-theme-components)
If you want add your own component, you can use the `swizzle` command. Check more at our [doc](https://docusaurus.io/docs/using-themes#swizzling-theme-components)
2 changes: 1 addition & 1 deletion packages/docusaurus-init/templates/classic/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Website

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

## Installation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ author_image_url: https://avatars1.githubusercontent.com/u/17883920?s=460&v=4
tags: [hello, docusaurus]
---

Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://v2.docusaurus.io/).
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://docusaurus.io/).

<!--truncate-->

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Have 5 more minutes? Take a look at **[versioning](./manage-docs-versions.md)**

## What's next?

- Read the [official documentation](https://v2.docusaurus.io/).
- Add a custom [Design and Layout](https://v2.docusaurus.io/docs/styling-layout)
- Add a [search bar](https://v2.docusaurus.io/docs/search)
- Find inspirations in the [Docusaurus showcase](https://v2.docusaurus.io/showcase)
- Get involved in the [Docusaurus Community](https://v2.docusaurus.io/community/support)
- Read the [official documentation](https://docusaurus.io/).
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
- Add a [search bar](https://docusaurus.io/docs/search)
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ npm run serve

The `build` folder is now served at `http://localhost:3000/`.

You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://v2.docusaurus.io/docs/deployment)**).
You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).
2 changes: 1 addition & 1 deletion packages/docusaurus-init/templates/facebook/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Website

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

### Installation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ author_image_url: https://avatars1.githubusercontent.com/u/17883920?s=460&v=4
tags: [hello, docusaurus]
---

Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://v2.docusaurus.io/).
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://docusaurus.io/).

<!--truncate-->

Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-migrate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ A CLI tool to migrate from older versions of Docusaurus.

## Usage

Please see [the migration documentation](https://v2.docusaurus.io/docs/migration) for more information.
Please see [the migration documentation](https://docusaurus.io/docs/migration) for more information.
2 changes: 1 addition & 1 deletion packages/docusaurus-plugin-client-redirects/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Client redirects plugin for Docusaurus.

## Usage

See [plugin-client-redirects documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-client-redirects).
See [plugin-client-redirects documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-client-redirects).
2 changes: 1 addition & 1 deletion packages/docusaurus-plugin-content-blog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Blog plugin for Docusaurus.

## Usage

See [plugin-content-blog documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
See [plugin-content-blog documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
2 changes: 1 addition & 1 deletion packages/docusaurus-plugin-content-docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Docs plugin for Docusaurus.

## Usage

See [plugin-content-docs documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs).
See [plugin-content-docs documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs).
2 changes: 1 addition & 1 deletion packages/docusaurus-plugin-content-pages/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Pages plugin for Docusaurus.

## Usage

See [plugin-content-pages documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-pages).
See [plugin-content-pages documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-pages).
2 changes: 1 addition & 1 deletion packages/docusaurus-plugin-debug/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Debug plugin for Docusaurus.

## Usage

See [plugin-debug documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-debug).
See [plugin-debug documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-debug).
2 changes: 1 addition & 1 deletion packages/docusaurus-plugin-google-analytics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Google analytics plugin for Docusaurus.

## Usage

See [plugin-google-analytics documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-google-analytics).
See [plugin-google-analytics documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-google-analytics).
2 changes: 1 addition & 1 deletion packages/docusaurus-plugin-google-gtag/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Global Site Tag (gtag.js) plugin for Docusaurus.

## Usage

See [plugin-google-gtag documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-google-gtag).
See [plugin-google-gtag documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-google-gtag).
2 changes: 1 addition & 1 deletion packages/docusaurus-plugin-pwa/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Progressive web app plugin for Docusaurus.

## Usage

See [plugin-pwa documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-pwa).
See [plugin-pwa documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-pwa).
2 changes: 1 addition & 1 deletion packages/docusaurus-plugin-sitemap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Simple sitemap generation plugin for Docusaurus.

## Usage

See [plugin-sitemap documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-sitemap).
See [plugin-sitemap documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-sitemap).
2 changes: 1 addition & 1 deletion packages/docusaurus-preset-bootstrap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Bootstrap preset for Docusaurus.

## Usage

See [presets documentation](https://v2.docusaurus.io/docs/presets).
See [presets documentation](https://docusaurus.io/docs/presets).
2 changes: 1 addition & 1 deletion packages/docusaurus-preset-classic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Classic preset for Docusaurus.

## Usage

See [presets documentation](https://v2.docusaurus.io/docs/presets).
See [presets documentation](https://docusaurus.io/docs/presets).
2 changes: 1 addition & 1 deletion packages/docusaurus-remark-plugin-npm2yarn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@ module.exports = {

| Property | Type | Default | Description |
| --- | --- | --- | --- |
| `sync` | `boolean` | `false` | Syncing tab choices (yarn and npm). See https://v2.docusaurus.io/docs/markdown-features/#syncing-tab-choices for details. |
| `sync` | `boolean` | `false` | Syncing tab choices (yarn and npm). See https://docusaurus.io/docs/markdown-features/#syncing-tab-choices for details. |
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ function useThemeContext(): ThemeContextProps {
const context = useContext<ThemeContextProps | undefined>(ThemeContext);
if (context == null) {
throw new Error(
'`useThemeContext` is used outside of `Layout` Component. See https://v2.docusaurus.io/docs/api/themes/configuration#usethemecontext.',
'`useThemeContext` is used outside of `Layout` Component. See https://docusaurus.io/docs/api/themes/configuration#usethemecontext.',
);
}
return context;
Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-theme-search-algolia/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Algolia search component for Docusaurus.

## Usage

See [`@docusaurus/theme-search-algolia` documentation](https://v2.docusaurus.io/docs/api/themes/@docusaurus/theme-search-algolia).
See [`@docusaurus/theme-search-algolia` documentation](https://docusaurus.io/docs/api/themes/@docusaurus/theme-search-algolia).
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ function createInlineHtmlBanner(baseUrl: string) {
return `
<div id="${BannerId}" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">
<p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>
<p>A very common reason is a wrong site <a href="https://v2.docusaurus.io/docs/docusaurus.config.js/#baseurl" style="font-weight: bold;">baseUrl configuration</a>.</p>
<p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseurl" style="font-weight: bold;">baseUrl configuration</a>.</p>
<p>Current configured baseUrl = <span style="font-weight: bold; color: red;">${baseUrl}</span> ${
baseUrl === '/' ? ' (default value)' : ''
}</p>
Expand Down
Loading

0 comments on commit 7834948

Please sign in to comment.