Skip to content

Commit

Permalink
Merge pull request #39 from jhipster/new-website-sync-be9dc09c
Browse files Browse the repository at this point in the history
Update to use new website
  • Loading branch information
hide212131 authored Nov 4, 2024
2 parents 93563a1 + 676df31 commit 9afe7c0
Show file tree
Hide file tree
Showing 1,678 changed files with 81,061 additions and 108,037 deletions.
3 changes: 0 additions & 3 deletions .bundle/config

This file was deleted.

51 changes: 51 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Deploy to GitHub Pages

on:
push:
branches:
- main
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

jobs:
build:
name: Build Docusaurus
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 20
cache: npm

- name: Install dependencies
run: npm ci
- name: Build website
run: npm run build

- name: Upload Build Artifact
uses: actions/upload-pages-artifact@v3
with:
path: build

deploy:
name: Deploy to GitHub Pages
needs: build

# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source

# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
24 changes: 24 additions & 0 deletions .github/workflows/test-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Test deployment

on:
pull_request:
branches:
- main

jobs:
test-deploy:
name: Test deployment
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 20
cache: npm

- name: Install dependencies
run: npm ci
- name: Test build website
run: npm run build
34 changes: 20 additions & 14 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,17 +1,23 @@
_site
# Dependencies
/node_modules
/bower_components
/vendor
debug.log
npm-debug.log

# Intellij
.idea/
*.iml
*.iws
Gemfile.lock
.jekyll-metadata
.bundle/
# Production
/build

# VSCode
.vscode/
# 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*

# IDEA
/.idea
3 changes: 3 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"singleQuote": true
}
9 changes: 0 additions & 9 deletions 404.md

This file was deleted.

6 changes: 0 additions & 6 deletions Gemfile

This file was deleted.

80 changes: 0 additions & 80 deletions JHipster-Developer-Association-CLA.md

This file was deleted.

61 changes: 45 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,57 @@
- 本家のリポジトリ: https://github.com/jhipster/jhipster.github.io
- [日本語訳について](#日本語訳について)

**Note**:スタイルを変更する場合は、`css/scss`以下にある`.scss`ファイルを更新し、`npm run sass`を実行してCSSを生成してください。CSSを直接更新しないでください。
<p align="center">
<br />
<a href="https://jhipster.tech">
<img src="./static/images/logo/logo-jhipster.svg" height="60px">
</a>
</p>

このWebサイトはGitHub Pagesでレンダリングされています。
<p align="center">
<a href="https://jhipster.tech">JHipster</a> ウェブサイトは、最新の静的サイトジェネレーターである <a href="https://docusaurus.io/">Docusaurus</a> を使用して構築されています。
</p>
<br />

ローカルで実行する場合は以下のとおりです。
### インストール

- [ここをForkして](https://github.com/jhipster/jhipster.github.io/fork) リポジトリを作成し、あなたのファイルシステムにクローンします
- [Jekyllをインストールしてください](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/)
- 初めての場合は、`npm install && bundle install`を実行します
- システムディレクトリへのインストールを避けたい場合は、代わりに`bundle install --path vendor/bundle`によってvendorディレクトリにインストールします
- Mac OSで`nokogiri`のインストールがうまくいかない場合は、`bundle config build.nokogiri -use-system-libraries=true --with-xml2-include="$(xcrun --show-sdk-path)"/usr/include/libxml2` を試してください
- リポジトリをクローンしたフォルダで `bundle exec jekyll serve` または `npm start` を実行します
- http://localhost:4000 からアクセスできるようになります
```
npm install
```

(Windows環境では推奨)DockerとDocker-Composeで実行する場合は以下のとおりです。
### ローカル開発

- [ここをForkして](https://github.com/jhipster/jhipster.github.io/fork) リポジトリを作成し、あなたのファイルシステムにクローンします
- `docker-compose up`を実行します
- http://0.0.0.0:4000 からアクセスできるようになります
```
npm start
```

このコマンドにより、ローカル開発サーバーが起動し、ブラウザウィンドウが開きます。ほとんどの変更は、サーバーの再起動を必要とせずにライブで反映されます。

# 日本語訳について
### ビルド

```
npm run build
```

このコマンドは、`build`ディレクトリに静的コンテンツを生成し、任意の静的コンテンツホスティングサービスで提供できます。

### デプロイ

SSHを使用する場合:

```
USE_SSH=true npm run deploy
```

SSHを使用しない場合:

```
GIT_USER=<あなたのGitHubユーザー名> npm run deploy
```

GitHub Pagesをホスティングに使用している場合、このコマンドはウェブサイトをビルドして`gh-pages`ブランチにプッシュする便利な方法です。

## 日本語訳について
本サイトの日本語訳にあたっては、OSS活動へも使用可能な[みんなの自動翻訳@TexTra®](https://mt-auto-minhon-mlt.ucri.jgn-x.jp/)の翻訳内容を活用させていただきました。この場を借りてお礼を申し上げます。

翻訳の文体は、本家のpackage.jsonにtextlintパッケージを加えての指摘と、TexTraの翻訳内容になるべく従うことで、統一させています。
Expand All @@ -50,4 +79,4 @@
`gh-pages`はほぼ全て`main`ブランチと同様ですが、ごく一部、日本語サイト表示のために`gh-pages`のみ変更した内容があります。
`main`との差分は[こちら](https://github.com/jhipster/jp/compare/main...gh-pages)を見て確認してください。
`main`に書かない理由は、本家のサイトの構造上、`main`に入れるとローカルのテスト環境で動かないためです。
結果、本家との差分が`main``gh-pages`で散在しまいますが、`gh-pages`の変更箇所は大幅なサイトの変更がない限りほぼ更新することはないので、しばらくこの構造で運用していきます。
結果、本家との差分が`main``gh-pages`で散在しまいますが、`gh-pages`の変更箇所は大幅なサイトの変更がない限りほぼ更新することはないので、しばらくこの構造で運用していきます。
Loading

0 comments on commit 9afe7c0

Please sign in to comment.