下記URLで運用している社内エンジニアによる技術情報を主としたコンテンツです。
https://dev.to/seattleconsulting
目的は、
- 対社内
- 誰がどんな技術に興味を持っているのかを表明・認識する場
- 継続的なスキルアップと相互サポートができる場
- 対社外
- 会社の中にこんなことができる人がいるというアピールの場
- 会社としてこんなことをやっているというアピールの場
という場所として発展していけたら良いなと思っています。
以下の手順を実施してください。 必要なものはGitHubアカウント、dev.toアカウント。 あると良いのが社内Slackアカウントです。Slackアカウントを持っていないという人は申請してください。
- GitHubアカウント作成
- ブログ運用用のGitHubリポジトリをclone
- dev.toアカウント作成(GitHubアカウントと紐付け)
- dev.toで自身のsettingsページのOrganizationで、メールで送ったシークレットを入力してOrganizationに参加(もらっていない人は誰かに転送してもらってください)
ただ記事を書くだけであれば投稿するだけで良いのですが、相互サポートという意味でも、履歴管理とレビューのフローを入れたいと思います。 以下の流れです。
- 記事を書く(ローカル)
- 記事のレビュー依頼(GitHub)
- レビュー指摘を修正・再レビュー(GitHub)
- 記事を公開(dev.to)
まずはGitHubで記事を書きます。
- 記事のURL=ファイル名を英語で決めます。なんでも良いですが、出来るだけ内容が想像しやすいものが好ましいです。例:
hoge.md
- 公開したい対象年月を決めます。例:2019-09
- cloneしたプロジェクトのcontentsフォルダ配下の、公開したい対象年月フォルダ配下に
hoge.md
を作ります。フォルダがなければ作成してください - gitでブランチを作ります。ブランチ命名規則は
feature/<記事ファイル名>
作成コマンド例:git checkout -b feature/hoge
- 記事をMarkdownで書きます。VSCodeなどのエディタでプレビューを見ながら書くのがオススメです。lintなどで構文エラーも出来るだけ無くしましょう
- 記事をコミットします
次にレビュー依頼=Pull Request(以下PR)を出しましょう。 ブランチ戦略はGitHub Flowを採用します。GitHubフローの概要はこの辺を参考にしてください。
- 作成したブランチ上で
git push origin <ブランチ名>
を実行 - GitHubリポジトリページを開いてPullRequestを作成(Slackの#blogチャネルにも通知が来る)。このとき、レビューして欲しいポイントを書くと良い
- レビューを待つ
ただ待っているだけだと誰もレビューしてくれない可能性があるので、Slackでも促してみましょう。 レビューしてくれた人は、OKならばmasterにマージしてブランチも削除してください。
レビューで指摘があれば修正しましょう。 修正が完了したら、再度レビューを依頼します。このとき同じPRを使っても良いですし、別PRを作っても良いです。
無事レビューが通ったら、dev.toで記事を公開しましょう。 書き方や、ヘッダ部分の説明はこの記事が詳しいので参考にしてください。
WRITE A POST
を押す- Organizationを選択するプルダウンが表示され流ので
Seattle Consulting, Inc.
を選択 - PRが通った記事Markdownをコピペ
- ヘッダを
published: true
に変更 - すでにQiitaや自分のブログなどで公開済みの記事の場合で、かつそちらが元ネタであると主張したい場合はヘッダに
canonical_url: <元記事URL>
を追加 SAVE CHANGES
を押して公開!