Skip to content

Latest commit

 

History

History
83 lines (41 loc) · 4.6 KB

start_editing.md

File metadata and controls

83 lines (41 loc) · 4.6 KB

#cpprefjpを編集するには

本cpprefjpサイトは、Google Sitesサービス上に構築されていますが、編集自体はGitHubリポジトリにあるMarkdown形式のプレーンテキストで行います。

cpprefjpサイトのGitHubリポジトリは、以下になります:

また、cpprefjpサイト上に掲載する画像ファイルのようなリソースも、GitHubリポジトリで管理しています。

##GitHubからcpprefjpサイトへの自動反映 GitHub上で記述したMarkdown(.md)形式のリファレンスは、自動的にhtmlに変換されて、cpprefjpサイトに反映されます。

###反映間隔 反映間隔は、1日1回となります。何らかの理由で、すぐに反映させたい場合は、cpprefjp/siteリポジトリに、Issue報告としてご連絡ください。

###変換エラーの検出 Markdown形式からhtmlへの変換で、何らかのエラーが発生した場合、cpprefjp/siteリポジトリのIssueとして登録されます。Issueは、コミッタ全員に通知されますので、関連する編集者の方は対応お願いします。

問題を修正した場合、自動反映ツールが自動的にチケットをクローズしますので、編集者の方は自分でチケットをクローズしないようお願いします。

###自動反映ツール 自動反映ツールも、GitHub上で開発が進められています。

機能要望やpull request等がありましたら、こちらにお願いします。

このツールは、コアメンバの一人であるmelponさんが保持しているサーバー上で動作しています。

##編集権限を得るには 編集権限は現在のコミッタに与えてもらうか、pull requestしてコミッタに修正を取り込んでもらうかする必要があります。

旧cpprefjpサイトで編集を行っていた方には、優先的に編集権限をお渡しします。

以下のページに載っているコミッタの人たちの誰かにコンタクトをとってもらうか、cpprefjp/siteリポジトリのIssue報告として、編集権限の申請を行ってください。

コミッタから直接お誘いに行く場合もありますので、快く引き受けていただければ幸いです。

cpprefjpサイトの編集に慣れていない方は、pull requestからでもぜひ始めてみてください。これは、編集権限を得るための審査ではなく、編集の練習のためだと考えてください。pull requestを何回かいただければ、継続して活動していただけるものと判断し、編集権限をお渡しします。

##Markdown形式による編集方法 cpprefjpサイトは、Markdown(.md)形式でリファレンスを記述します。

Markdownは、GitHubサービス上でドキュメントを記述するフォーマットとして広く使用されている形式です。

Markdownの記述方法をわかりやすく解説してくれているWebサイトは、すでに数多く存在しますので、詳細はそちらを参照してください。

Markdown形式では、htmlのタグも併用できますが、cpprefjpサイトでは積極的にはhtmlタグを使用しない方針です。できるだけ、Markdown形式でできる範囲内で解決するようにしてください。

新規リファレンスを書くにあたって、雛形ページを用意していますので、そちらをベースにして編集作業を行ってください。

初めての人は見ておいたほうがよいページ