# コーダー新規参画者用の方へ.md

## 仕事の流れと利用ツールについて

【新規参画者向けWiki】
https://nkohweb.backlog.com/alias/wiki/256159

【利用ツールについて】
https://nkohweb.backlog.com/alias/wiki/268961

---

# 開発ツール 初期設定を完了させよう

## 1.AWSCodeCommitとSourceTree
こちらを参照のうえセットアップを行いましょう。
https://web.kabaya-ohayo.com/repository/

## 2.SFTP3兄弟
以下3点の設定を行いましょう。
1. AWS VPN
/Volumes/(HD_東京)web戦略/◆各案件/サーバー関係(AWS,SSL）/AWS接続情報/AWS-VPN/kabaya_aws_client_vpn_settings.pdf
3. [SecurePips](https://nkohweb.backlog.com/wiki/WEB_SEC/2001_%E3%82%B3%E3%83%B3%E3%83%86%E3%83%B3%E3%83%84%E5%88%B6%E4%BD%9C%2F%E3%83%84%E3%83%BC%E3%83%AB%2FTransmit+%26+SecurePipe%E3%81%AE%E8%A8%AD%E5%AE%9A)
4. Transmit

# 日々の仕事について
## PC起動後
### Outlookの確認
https://outlook.office.com/mail/inbox
- 自分宛てのメール・関連するメールについては随時チェックしましょう

https://outlook.office.com/calendar/view/day
- 自分の予定、コレボレーション相手のスケジュールを把握しておきましょう

### Microsoft Teamsアプリの確認
- 個別に連絡やトピックスがきていないかを確認しましょう

### Backlogの確認
https://nkohweb.backlog.com/dashboard
- タスクはここで振られるので常に確認しましょう

------

## 基本作業を行うために

各サイトのソースディレクトリ
:memo: <font color="tomato">自分の環境をメモしてください</font>

### AWSConsoleへのログイン
GitホスティングしているAWSCodeCommitを活用するためにもあからじめログインしておきましょう。

### ローカル環境立ち上げ -- Docker --

https://nkohweb.backlog.com/alias/wiki/266722

- 基本的には対象のフォルダに移動してdocker-compose up で大丈夫です。
詳細は各リポジトリのREADME.mdに記載していますのでそちらを確認しましょう。

### エディタの立ち上げ
エディタの指定はありません。
今のメンバーは主に Visual Studio Code を使っています。
Adobe Dreamweaverはリンクしていない不要な画像を割り出してくれるなどの機能があるようなので、そういった用途限定で使用してみてもいいかもしれません。

### SourceTree立ち上げ
Git操作をするにあたり必要となるので立ち上げておきましょう。
Visual Studio Codeの拡張機能を使う、コマンドを利用する場合は必須ではありません。

------

# 運用について

## 運用更新についての基本
- 基本的にはリリース手順に則って作業しましょう。（別途ご説明します）

## リリースフロー
https://hackmd.io/@nkohweb-fm/SkP9nStkD
基本的にはこの図の流れで進行します。
リリース手順は主に3パターンあります。

まずは作業する対象のサイト、ページがどのフローに該当するのかを見極めましょう。

### パターンA：WebReleaseからアップする
#### WebRelease
（www.kabaya.cp.jp / ohayo-milk.co.jp / lifepartnerikeda.com ）

上記3サイトではWebReleaseというCMSを使用しています。
WebRelease化されている静的ページについては、WebRelease側で公開をしています。
HTMLやCSS、JS、画像等WebReleaseに組み込むものについては原則WebReleaseからアップロード・更新するようにし、WebReleaseで管理されていないページ・ファイルのみ、SFTPからアップしましょう。

WebReleaseでの操作方法については、下記を参照ください。
https://nkohweb.backlog.com/alias/wiki/157498

【注意】
※HTMLやCSS等、すでにWebRelease化されているものを手動でSFTPでアップロードしてしまうとパーミッションが変わってしまう、WebRelease側のバージョン管理対象外となるため要注意

例）kabayaの場合、/en/配下に付随したCSSと画像に関してはWebReleaseでアップし、HTMLファイルのみSFTPでアップ。
/recruit/ディレクトリ配下は基本的にWebRelease管轄外。等といった構造になっています。
慣れないうちはWebRelease化されているかどうかの判断に迷うことがあると思いますので、ディレクターに確認しましょう。
また、テスト環境であれば、自由に更新していただいて問題ないのである程度触って慣れておくことをおすすめします。
（※コンテンツの中身や設定等はPrd,Stgと同期されていません）

### パターンB：SFTPでファイルをアップロードする
1. SourceTreeを使って差分を抽出、アップするファイル/削除するファイルを明確にしておきましょう
※ 不要な画像など削除するものは抽出されないので要注意
3. AWS VPNに接続しましょう
4. Secure Pipes（雲のアイコンのアプリ）で接続先を振り分けているため、Secure Pipesを起動しましょう
5. 起動するとデスクトップ上部メニューバーの右上に雲のアイコンが出現します
stgと書かれているものはステージング、prdと書かれているものは本番です
自分が接続したいホスト先を選択し、クリックしてください

※実際のTransmitを利用する際の注意点などをまとめた資料は[こちら](https://nkohweb.backlog.com/wiki/WEB_SEC/%E6%96%B0%E8%A6%8F%E5%8F%82%E7%94%BB%E8%80%85%E5%90%91%E3%81%91Wiki%2F%E3%83%84%E3%83%BC%E3%83%AB%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)を参照ください。

【注意】
- 作業が終わり、別のサーバにアクセスしたい場合は必ず、Secure Pipesを再起動してから希望のサーバ先を選択し直してください。
アプリのキャッシュにより画面上では別のサーバにアクセスしているようでも、裏では以前のサーバに繋がっていることがあります。
SFTPのアクセス情報はStgもPrdも同一のため、意図せずPrdに上げてしまうなど、トラブルの原因となりますので十分ご留意ください。
- 全サイトCDNサービスのCloudFrontを導入していますので、WebRelease郡のサイト以外はcache_clear.txtをアップするか、魔法のホウキでキャッシュクリアを行ってください。

### Transmit(SFTPソフト)について
Transmitにファイルやディレクトリを上書きする場合は「置き換え」ではなく **「統合」** を押す
PHPファイルやhtaccess等、一部でアップロードしたくてもアップロードできないファイルがある場合（他制作会社がアップしたファイル等は権限が変更されている）は、加藤さん、仁木さんに相談してください

#### h4本番と手元のファイルに差分がある場合
2019年6月以降〜Gitによるバージョン管理をはじめました
基本的には本番に上がっているファイルと手元のファイルに差分はないはずですが、
ファイルの一部をCMSで管理していることもあるため、**一部ファイルで差分が生じている場合もありえます**
ですので、一括でファイルを書き換える場合等、大量のファイルを操作する場合は、本番のファイルと手元のファイルの差分を確認しておくことをおすすめします
不安でしたら、一度ソースの差分をとってから本アップするなどの方法もありです

差分が生じやすい箇所
https://nkohweb.backlog.com/alias/wiki/252736

### パターンC：AWSCodeCommitを用いて自動でデプロイする
[自動デプロイフロー(S3)について](https://nkohweb.backlog.com/wiki/WEB_SEC/3002_AWS%2F%E8%87%AA%E5%8B%95%E3%83%87%E3%83%97%E3%83%AD%E3%82%A4%E3%83%95%E3%83%AD%E3%83%BC%28S3%29%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)参照

## Git運用について
### 管理対象コンテンツ
[Gitの管理対象についてはこちら](https://nkohweb.backlog.com/wiki/WEB_SEC/4001_Git+%26+SourceTree%2FGit%E3%81%AE%E7%AE%A1%E7%90%86%E5%AF%BE%E8%B1%A1%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)参照
### ブランチ運用について
#### 現在のブランチ運用
**通称：手抜きGitHub Flow**です。
(本来はfeatureからmasterのマージタイミングでPullRequestを利用したレビューをやるのがGitHub Flow)
| ブランチ名 | 役割 |
| :-------------- | :----------------------------------------------------------- |
| masterブランチ | 本流のブランチ。本番環境にリリースされているコードと同一。 <br />基本的にはマージされるだけで直接編集されないブランチ。 |
| featureブランチ | Backlogの課題毎にmasterブランチから枝分かれするブランチ。<br/>本番環境へのリリースが完了した段階で、masterブランチにマージ。 |

#### ブランチ命名ルール
厳密なルールは設けていませんが、基本featureブランチとなりますので、基本としては以下のような名前が多いです。

Backlogキー_対象ページ_内容
WEB_SEC-xxxx_

#### コミットメッセージについて
何をしたのかを英語の動詞にしましょう（※わかりやすさ追求のため日本語でもいいとは思うけど‥）
日本語でコミットメッセージを書きます
1つの対応につき1つコミットをします
「何を」と「なぜ」を書きましょう

------
# 時間管理を行いましょう

## 作業計画をたてましょう

## 作業時間管理を行いましょう

一通りの作業完了後にBacklogにて作業時間を報告してください。
Toggleを使用し、作業時間を随時チェックしてください。
https://toggl.com/app/timer

厳密なルールはありませんが、おすすめは下記の通りです。
**Backlogの課題｜ご自身が行う作業におけるマイルストーンベース**
例）
- WEB-SEC-XXXX 課題名が入ります｜全体設計
- WEB-SEC-XXXX 課題名が入ります｜HTMLマークアップ
- WEB-SEC-XXXX 課題名が入ります｜CSS設計
- WEB-SEC-XXXX 課題名が入ります｜環境構築
など

## 作業報告を行いましょう

■作業時間内訳
・修正作業 1
・修正確認作業 0.25

合計 1.25

------