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

feat: Rewriting of links due to repository changes #510

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ jobs:
- name: Download and extract GROWI source
run: |
mkdir -p tmp/growi
export GROWI_ARCHIVE_URL=https://github.com/weseek/growi/archive/master.tar.gz
export GROWI_ARCHIVE_URL=https://github.com/growilabs/growi/archive/master.tar.gz
curl -SL $GROWI_ARCHIVE_URL | tar -xz -C tmp/growi --strip-components 1

- name: Build and deploy
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# growi-docs

[![Deploy](https://github.com/weseek/growi-docs/actions/workflows/deploy.yml/badge.svg)](https://github.com/weseek/growi-docs/actions/workflows/deploy.yml)
[![Deploy](https://github.com/growilabs/growi-docs/actions/workflows/deploy.yml/badge.svg)](https://github.com/growilabs/growi-docs/actions/workflows/deploy.yml)

## Requirements

Expand Down
6 changes: 3 additions & 3 deletions docs/.vuepress/config-docs-growi-org.js
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ module.exports = {
},
themeConfig: {
context: 'docs-growi-org',
repo: 'weseek/growi-docs',
repo: 'growilabs/growi-docs',
docsDir: 'docs',
editLinks: true,
editLinkText: 'Edit this page on GitHub',
Expand All @@ -102,7 +102,7 @@ module.exports = {
{ text: 'Admin Guide', link: '/en/admin-guide/' },
{ text: 'Developers Guide', link: '/en/dev/' },
{ text: 'API Reference', link: '/en/api/' },
{ text: 'Release Note', link: 'https://github.com/weseek/growi/releases' },
{ text: 'Release Note', link: 'https://github.com/growilabs/growi/releases' },
{
text: 'External Sites',
items: [
Expand Down Expand Up @@ -354,7 +354,7 @@ module.exports = {
{ text: '管理者ガイド', link: '/ja/admin-guide/' },
{ text: '開発ガイド', link: '/ja/dev/' },
{ text: 'API リファレンス (英語)', link: '/en/api/' },
{ text: 'リリースノート', link: 'https://github.com/weseek/growi/releases' },
{ text: 'リリースノート', link: 'https://github.com/growilabs/growi/releases' },
{
text: '外部サイト',
items: [
Expand Down
12 changes: 6 additions & 6 deletions docs/en/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@ home: true
heroImage: https://user-images.githubusercontent.com/1638767/68901318-100dd280-0779-11ea-83ab-51f111972ab1.png
actionText: Get Started
actionLink: /guide/
footer: © 2018 WESEEK, Inc.
footer: © 2024 GROWI, Inc.
---
<!-- for docs-growi-org root-->

<div align="center">
<a href="https://github.com/weseek/growi/" target="_blank"><img src="https://img.shields.io/github/stars/weseek/growi.svg?style=social&label=Stars"></a>
<a href="https://github.com/weseek/growi/" target="_blank"><img src="https://img.shields.io/github/forks/weseek/growi.svg?style=social&label=Fork"></a>
<a href="https://github.com/growilabs/growi/" target="_blank"><img src="https://img.shields.io/github/stars/growilabs/growi.svg?style=social&label=Stars"></a>
<a href="https://github.com/growilabs/growi/" target="_blank"><img src="https://img.shields.io/github/forks/growilabs/growi.svg?style=social&label=Fork"></a>
</div>

<div align="center">
<a href="https://github.com/weseek/growi/releases/latest" target="_blank"><img src="https://img.shields.io/github/release/weseek/growi.svg"></a>
<a href="https://hub.docker.com/r/weseek/growi/" target="_blank"><img src="https://img.shields.io/docker/pulls/weseek/growi.svg" /></a>
<a href="https://github.com/growilabs/growi/releases/latest" target="_blank"><img src="https://img.shields.io/github/release/growilabs/growi.svg"></a>
<a href="https://hub.docker.com/r/growilabs/growi/" target="_blank"><img src="https://img.shields.io/docker/pulls/growilabs/growi.svg" /></a>
</div>

<div class="features">
Expand All @@ -28,6 +28,6 @@ footer: © 2018 WESEEK, Inc.
</div>
<div class="feature">
<h2>Ever-Growing</h2>
<p>WESEEK, Inc., together with our community of contributors, is committed to creating the most powerful and desirable communication tool. Please join our <a href="https://communityinviter.com/apps/wsgrowi/invite" target="_blank"> Slack </a> with any questions or suggestions!</p>
<p>GROWI, Inc., together with our community of contributors, is committed to creating the most powerful and desirable communication tool. Please join our <a href="https://communityinviter.com/apps/wsgrowi/invite" target="_blank"> Slack </a> with any questions or suggestions!</p>
</div>
</div>
2 changes: 1 addition & 1 deletion docs/en/admin-guide/admin-cookbook/audit-log-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ Actions included/excluded in the group set in `AUDIT_LOG_ACTION_GROUP_SIZE` can

## List of supported actions

- [name of action that can be collected](https://github.com/weseek/growi/blob/master/packages/app/src/interfaces/activity.ts#L9)
- [name of action that can be collected](https://github.com/growilabs/growi/blob/master/packages/app/src/interfaces/activity.ts#L9)
2 changes: 1 addition & 1 deletion docs/en/admin-guide/admin-cookbook/custom-rate-limit.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Endpoints are restricted by default in the table below.

Other endpoints that require restrictions have default customized initial values set as restrictions by the following configuration file.

<https://github.com/weseek/growi/blob/master/packages/app/config/rate-limiter.ts>
<https://github.com/growilabs/growi/blob/master/packages/app/config/rate-limiter.ts>

## Limit Customization

Expand Down
4 changes: 2 additions & 2 deletions docs/en/admin-guide/admin-cookbook/integrate-with-hackmd.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@

## Create a new HackMD(CodiMD) container with [growi-docker-compose](/en/admin-guide/getting-started/docker-compose.html)

[This](https://github.com/weseek/growi-docker-compose/tree/master/examples/integrate-with-hackmd) example will be used.
[This](https://github.com/growilabs/growi-docker-compose/tree/master/examples/integrate-with-hackmd) example will be used.

Set up will follow these instructions [README.md](https://github.com/weseek/growi-docker-compose/blob/master/examples/integrate-with-hackmd/README.md).
Set up will follow these instructions [README.md](https://github.com/growilabs/growi-docker-compose/blob/master/examples/integrate-with-hackmd/README.md).

1. Prepare `examples/integrate-with-hackmd/docker-compose.override.yml`
2. Add environment variables to GROWI container
Expand Down
4 changes: 2 additions & 2 deletions docs/en/admin-guide/admin-cookbook/mongodb-backup-regular.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ See [weseek/mongodb-awesome-backup](https://github.com/weseek/mongodb-awesome-ba
If GROWI is installed with [growi-docker-compose](/en/admin-guide/getting-started/docker-compose.html), preparing a backup container is even easier.
:::

* Refer to weseek/growi-docker-compose [Example](https://github.com/weseek/growi-docker-compose/tree/master/examples/backup-mongodb-data), and follow the steps below.
* Refer to growilabs/growi-docker-compose [Example](https://github.com/growilabs/growi-docker-compose/tree/master/examples/backup-mongodb-data), and follow the steps below.

1. clone
```bash
git clone https://github.com/weseek/growi-docker-compose.git growi
git clone https://github.com/growilabs/growi-docker-compose.git growi
cd growi
```
2. Copy `docker-compose.override.yml` to the root directory.
Expand Down
4 changes: 2 additions & 2 deletions docs/en/admin-guide/admin-cookbook/multi-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This chapter introduces how to launch three GROWI sites.
### Build Image

```bash
git clone https://github.com/weseek/growi-docker-compose.git growi
git clone https://github.com/growilabs/growi-docker-compose.git growi
cd growi
docker build -t growimulti_app .
```
Expand Down Expand Up @@ -139,7 +139,7 @@ docker-compose rm app-1
docker-compose rm app-2
docker-compose rm app-3
docker rmi growimulti_app
docker rmi weseek/growi:3
docker rmi growilabs/growi:3
```

### Rebuild Image
Expand Down
4 changes: 2 additions & 2 deletions docs/en/admin-guide/downgrading/50x-to-45x.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ If you want to downgrade from v5.0 to v4.5 or lower, you need to migrate down th
Please follow the steps below.

::: tip
Downgrading is availble for systems running on-premise or running with [weseek/growi-docker-compose](https://github.com/weseek/growi-docker-compose).
Downgrading is availble for systems running on-premise or running with [growilabs/growi-docker-compose](https://github.com/growilabs/growi-docker-compose).
Please note that downgrading is not supported for other forms of system operations.
:::

Expand Down Expand Up @@ -50,7 +50,7 @@ Please undertake it at your own risk as an administrator.
2. Clone the repository in an environment where you can access MongoDB in production

```bash
git clone https://github.com/weseek/growi -b v5.0.0 --depth 1
git clone https://github.com/growilabs/growi -b v5.0.0 --depth 1

# Get dependent libraries
yarn lerna bootstrap
Expand Down
4 changes: 2 additions & 2 deletions docs/en/admin-guide/getting-started/centos.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,14 +228,14 @@ $ sudo systemctl status mongod

### Installation

Download the source code from [https://github.com/weseek/growi](https://github.com/weseek/growi), and check the latest stable version at [https://github.com/weseek/growi/releases](https://github.com/weseek/growi/releases).
Download the source code from [https://github.com/growilabs/growi](https://github.com/growilabs/growi), and check the latest stable version at [https://github.com/growilabs/growi/releases](https://github.com/growilabs/growi/releases).

The installation procedure shown below will be carried out under `/opt/growi`.

```text
$ sudo mkdir -p /opt/
$ cd /opt/
$ sudo git clone https://github.com/weseek/growi /opt/growi
$ sudo git clone https://github.com/growilabs/growi /opt/growi
$ cd /opt/growi

# Check the tags
Expand Down
6 changes: 3 additions & 3 deletions docs/en/admin-guide/getting-started/docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ Software needed for setup are listed below.

## Download growi-docker-compose

Download or clone source code files from [https://github.com/weseek/growi-docker-compose](https://github.com/weseek/growi-docker-compose) .
Download or clone source code files from [https://github.com/growilabs/growi-docker-compose](https://github.com/growilabs/growi-docker-compose) .

```text
git clone https://github.com/weseek/growi-docker-compose.git growi
git clone https://github.com/growilabs/growi-docker-compose.git growi
```

## Build GROWI
Expand Down Expand Up @@ -87,7 +87,7 @@ Remove Docker containers and Docker images.

```text
docker-compose rm app mongo elasticseach
docker rmi weseek/growi:5
docker rmi growilabs/growi:5
```

Pull latest GROWI, and create a fresh Docker image and build up containers.
Expand Down
4 changes: 2 additions & 2 deletions docs/en/admin-guide/getting-started/ubuntu-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,14 +234,14 @@ $ sudo systemctl status mongod

### Installation

Download the source code from [https://github.com/weseek/growi](https://github.com/weseek/growi), and check the latest stable version at [https://github.com/weseek/growi/releases](https://github.com/weseek/growi/releases).
Download the source code from [https://github.com/growilabs/growi](https://github.com/growilabs/growi), and check the latest stable version at [https://github.com/growilabs/growi/releases](https://github.com/growilabs/growi/releases).

The installation procedure shown below will be carried out under `/opt/growi`.

```text
$ sudo mkdir -p /opt/
$ cd /opt/
$ sudo git clone https://github.com/weseek/growi /opt/growi
$ sudo git clone https://github.com/growilabs/growi /opt/growi
$ cd /opt/growi

# Check the tags
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This guide will explain how to set up and manage Elasticsearch for full text sea
Please refer to system management page for instructions on activating and connecting to Elasticsearch.

- docker-compose
- Users of [weseek/growi-docker-compose](https://github.com/weseek/growi-docker-compose) will automatically have Elasticsearch activated by default. No additional setup is required.
- Users of [growilabs/growi-docker-compose](https://github.com/growilabs/growi-docker-compose) will automatically have Elasticsearch activated by default. No additional setup is required.
- ubuntu
- Please find instructions for setting up and using Elasticsearch [here](/en/admin-guide/getting-started/ubuntu-server.html#elasticsearch).
- Please set the environment variable `ELASTICSEARCH_URI` to the URI of the Elasticsearch instance. you will use for GROWI.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

- Assuming to migrate from [Crowi docker image + [bakudankun/crowi](https://github.com/crowi/docker-crowi)] to [weseek/growi-docker-compose](https://github.com/weseek/growi-docker-compose).
- Assuming to migrate from [Crowi docker image + [bakudankun/crowi](https://github.com/crowi/docker-crowi)] to [growilabs/growi-docker-compose](https://github.com/growilabs/growi-docker-compose).
- Migrate the following data.
- MongoDB container's data volume
- Uploaded file data from the App container
Expand Down
4 changes: 2 additions & 2 deletions docs/en/admin-guide/migration-guide/from-crowi-onpremise.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

## Set up Node.js Environment

- Set up Node.js, npm, and yarn. See [README.md#dependencies](https://github.com/weseek/growi/blob/master/README.md#dependencies).
- Set up Node.js, npm, and yarn. See [README.md#dependencies](https://github.com/growilabs/growi/blob/master/README.md#dependencies).
- Upgrade Node.js to 10.x
- Install yarn

Expand Down Expand Up @@ -63,7 +63,7 @@ node app.js

```bash
# clone
git clone https://github.com/weseek/growi.git
git clone https://github.com/growilabs/growi.git
cd growi
# install dependencies and build client
yarn
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ DO NOT EDIT `docker-compose.yml`. Only edit `Dockerfile`.
* **After**

```docker
FROM weseek/growi:3
FROM growilabs/growi:3
ENV APP_DIR /opt/growi
```
2. Because GROWI includes lsx plugin and pukiwiki-like-linker plugin in GROWI official image by default, comment out or delete the lines below.
Expand All @@ -42,7 +42,7 @@ DO NOT EDIT `docker-compose.yml`. Only edit `Dockerfile`.
# ;;
# ;; NOTE: In GROWI v3 and later,
# ;; 2 of official plugins (growi-plugin-lsx and growi-plugin-pukiwiki-like-linker)
# ;; are now included in the 'weseek/growi' image.
# ;; are now included in the 'growilabs/growi' image.
# ;; Therefore you will not need following lines except when you install third-party plugins.
# ;;
#RUN echo "install plugins" \
Expand Down
4 changes: 2 additions & 2 deletions docs/en/admin-guide/upgrading/34x.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ v3.4 uses different versions about Node.js and middlewares as below.
| MongoDB | 3.4 | 3.6 |
| Elasticsearch | 5.3 | 6.6 |

Also, the docker image that is used by [growi-docker-compose](https://github.com/weseek/growi-docker-compose) is modified to the image that provided by official [docker.elastic.co](https://www.docker.elastic.co/) instead of [docker-library/elasticsearch](https://github.com/docker-library/elasticsearch/blob/6854914f0b890840c75b6db9eeaefbc26177df9c/5/Dockerfile).
Also, the docker image that is used by [growi-docker-compose](https://github.com/growilabs/growi-docker-compose) is modified to the image that provided by official [docker.elastic.co](https://www.docker.elastic.co/) instead of [docker-library/elasticsearch](https://github.com/docker-library/elasticsearch/blob/6854914f0b890840c75b6db9eeaefbc26177df9c/5/Dockerfile).


## The case using on premise
Expand All @@ -27,7 +27,7 @@ Also, the docker image that is used by [growi-docker-compose](https://github.com
1. Upgrade Elasticsearch 6.6 or above and install plugins that were required so far
- Since index data can be rebuilt from GROWI's management screen, it can be discarded.

## The case using [growi-docker-compose](https://github.com/weseek/growi-docker-compose)
## The case using [growi-docker-compose](https://github.com/growilabs/growi-docker-compose)

1. Remove existing containers

Expand Down
6 changes: 3 additions & 3 deletions docs/en/admin-guide/upgrading/35x.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ Addition, v3.5 no longer supports following features:
## Plugins

::: tip
Systems that are launched by [the official docker image](https://hub.docker.com/r/weseek/growi/) will not be affected
Systems that are launched by [the official docker image](https://hub.docker.com/r/growilabs/growi/) will not be affected
:::

Upgrade the official plugins [weseek/growi-plugin-lsx](https://github.com/weseek/growi-plugin-lsx) and [weseek/growi-plugin-pukiwiki-like-linker
](https://github.com/weseek/growi-plugin-pukiwiki-like-linker) to the latest version that are released with schema version 3.
Upgrade the official plugins [growilabs/growi-plugin-lsx](https://github.com/growilabs/growi-plugin-lsx) and [growilabs/growi-plugin-pukiwiki-like-linker
](https://github.com/growilabs/growi-plugin-pukiwiki-like-linker) to the latest version that are released with schema version 3.

### Upgrade Plugins

Expand Down
6 changes: 3 additions & 3 deletions docs/en/admin-guide/upgrading/36x.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

GROWI v3.6 no longer supports Node.js v8.

v3.5 or below has the bug([weseek/growi#1361](https://github.com/weseek/growi/issues/1361)) that generate two databases wrongly.
v3.5 or below has the bug([growilabs/growi#1361](https://github.com/growilabs/growi/issues/1361)) that generate two databases wrongly.

## Node.js v8 is no longer supported

::: tip
Systems that are launched by [the official docker image](https://hub.docker.com/r/weseek/growi/) will not be affected
Systems that are launched by [the official docker image](https://hub.docker.com/r/growilabs/growi/) will not be affected
:::

### Upgrade Node.js

1. Upgrade Node.js to v10 or v12

## Avoid [weseek/growi#1361](https://github.com/weseek/growi/issues/1361)
## Avoid [growilabs/growi#1361](https://github.com/growilabs/growi/issues/1361)

::: warning
This problem is caused in the situation that using `MONGO_URI` with parameters of the form `?key=value`.
Expand Down
4 changes: 2 additions & 2 deletions docs/en/admin-guide/upgrading/41x.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ GROWI v4.1 no longer supports also [growi-plugin-attachment-refs](https://www.np

::: tip

- Systems that are launched by [the official docker image](https://hub.docker.com/r/weseek/growi/) will not be affected
- Systems that are launched by [the official docker image](https://hub.docker.com/r/growilabs/growi/) will not be affected
:::

### Upgrade Node.js
Expand All @@ -19,7 +19,7 @@ GROWI v4.1 no longer supports also [growi-plugin-attachment-refs](https://www.np

::: tip

- Systems that are launched by [the official docker image](https://hub.docker.com/r/weseek/growi/) will not be affected
- Systems that are launched by [the official docker image](https://hub.docker.com/r/growilabs/growi/) will not be affected
- Systems that do not install growi-plugin-attachment-refs will not be affected
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/en/admin-guide/upgrading/43x.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
GROWI v4.3 uses `lerna` to manage package dependencies.

GROWI v4.3 includes some official plugins in default.
Users no longer need to install [growi-plugin-lsx](https://github.com/weseek/growi-plugin-lsx), [growi-plugin-pukiwiki-like-linker](https://github.com/weseek/growi-plugin-pukiwiki-like-linker) and [growi-plugin-attachment-refs](https://github.com/weseek/growi-plugin-attachment-refs) before build client.
Users no longer need to install [growi-plugin-lsx](https://github.com/growilabs/growi-plugin-lsx), [growi-plugin-pukiwiki-like-linker](https://github.com/growilabs/growi-plugin-pukiwiki-like-linker) and [growi-plugin-attachment-refs](https://github.com/growilabs/growi-plugin-attachment-refs) before build client.


## Change build procedure
Expand Down
6 changes: 3 additions & 3 deletions docs/en/admin-guide/upgrading/50x.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ If you want to downgrade from v5.0 to v4.5 or lower, you need to migrate down th
For more information, please see [Downgrading from v5.0 to v4.5 or lower](/en/admin-guide/downgrading/50x-to-45x.html).

::: tip
Downgrading is available for systems running on-premise or running with [weseek/growi-docker-compose](https://github.com/weseek/growi-docker-compose).
Downgrading is available for systems running on-premise or running with [growilabs/growi-docker-compose](https://github.com/growilabs/growi-docker-compose).
Please note that downgrading is not supported for other forms of system operations.
:::

Expand Down Expand Up @@ -77,9 +77,9 @@ Elastic version 6 and version 7 are officially said to be index compatible, but
- Confirm that the index data for GROWI does not exist (if it does exist, then ensure it does not inherit the data of Elasticsearch version 6).
4. Start GROWI v5.0.x.

### If Using [weseek/growi-docker-compose](https://github.com/weseek/growi-docker-compose)
### If Using [growilabs/growi-docker-compose](https://github.com/growilabs/growi-docker-compose)

In addition to referring to [If Using Docker](#if-using-docker), please refer to this guide on github, [Wiki: Upgrade Elasticsearch from 6.x to 7.x](https://github.com/weseek/growi-docker-compose/wiki/Upgrade-Elasticsearch-from-6.x-to-7.x).
In addition to referring to [If Using Docker](#if-using-docker), please refer to this guide on github, [Wiki: Upgrade Elasticsearch from 6.x to 7.x](https://github.com/growilabs/growi-docker-compose/wiki/Upgrade-Elasticsearch-from-6.x-to-7.x).

## About The New v5 Compatible Format

Expand Down
Loading
Loading