GNU/Linux >> Linux の 問題 >  >> Linux

Atlantic.Netハウツー記事のフォーマットガイド

はじめに

Atlantic.Netに書き込みたいと思われる場合は、まず登録フォームに記入する必要があります。

Atlantic.Netのハウツー記事は、以下のセクションに示されている標準に準拠している必要があります。

セクション(概要、前提条件、チュートリアル自体を含む)
フォーマット(マークダウンまたは単純なHTML)
画像/スクリーンショット
元の作業

追加のガイダンスについては、スタイルガイドも確認してください。

セクション

各ハウツー記事は、記事の範囲を簡単に説明する「はじめに」セクションから始める必要があります。 「はじめに」という単語は、H3ヘッダー内に含める必要があります。

次の概要は、H3ヘッダーで示される前提条件である必要があります。前提条件には、適切な配布を含め、記事が関連するオペレーティングシステムを含める必要があります(例:「Ubuntu14.04以前」または「WindowsServer2012およびWindowsServer2012R2」)。

また、必要なパッケージ、役割、または機能とそのインストールを含める必要があります。この記事では構成については説明しません。そのインストール/構成をカバーする記事が存在し、リンクが含まれていることを確認してください。

例:(Fedora22クラウドサーバーへのWordPressのインストールから抜粋)

前提条件

–LAMPまたはLEMPを実行しているFedora22サーバーが必要です。 Fedora22LAMPまたはLEMPのハウツーをご覧ください。

記事の大部分であるチュートリアルは、前提条件のセクションに従います。

フォーマット

Atlantic.Netのハウツー記事は、Markdownまたは単純なHTMLで送信できます。

サポートされているテキスト形式:ヘッダーテキスト、コードブロック、インラインコード(コマンドとキーストローク用)、斜体(変数用)、太字(強調用)。

ヘッダー

H2は、チュートリアルの主要なセクションで使用する必要があります。

H3は、「はじめに」、「前提条件」、およびチュートリアルのサブセクションに使用する必要があります。

コードブロック

チュートリアルの一部として入力する必要のあるコードはすべて、コードブロックに含める必要があります。

ほとんどの場合、インラインコードは、コマンドが取る可能性のある変数またはオプションを説明するために使用されます。コードをインラインで参照する場合は、codeを使用できます 鬼ごっこ。この使用は、近くのコードブロックにすでに含まれているコードの一部を参照することに限定する必要があります。

例:

-rを使用するときは注意してください rmのオプション 。指定したパスに従属するすべてのファイルを再帰的に削除しようとします。

変数/カスタム情報フォーマット

変数またはカスタム構成エントリ(ホスト名など)のプレースホルダーは斜体にする必要があります。また、パーサーはすべてのイタリック体のエントリに色を付けます緑 。

強調

強調したい場合は、太字を使用してください 。

キーストローク

テキストとインラインでキーストロークを参照する場合は、code spanで囲みます。 。

例:

Enterを押します キー。

複数のキーを同時に押す必要があるキーストロークの場合は、キーの間にプラス記号(+)を使用します。

例:

終了するには、Ctrl+Cを押します 。

ユーザーを切り替えるには、最初にCtrl+Alt+Delを押します。 。

画像

ハウツーには、クリックする場所や画面の外観などの視覚的要素を示す適切なスクリーンショットを含める必要があります(たとえば、phpinfoページなど)。画像の最大幅は730ピクセルである必要があります。

現在ホストされているURLを使用して画像へのリンクを含めてください。出版が承認された記事には、関連するすべての画像がダウンロードされ、サーバーにホストされます。画像に加えて、次のものが必要です。

画像名 :フォーマットanet-articlename-## (ここで## 数字に置き換えられます(例:anet-how_to_install_lamp_debian_8-01) )。
Alt-Text :画像が読み込まれない場合の画像の簡単な説明。
キャプション :画像の下に表示される簡単な説明。

一意に識別できる情報は、できれば目立つプレースホルダー名(「example.com」や「192.168.0.2」など)を使用して隠しておく必要があります。

オリジナル作品

Atlantic.Net向けに書かれたすべての記事は、オリジナルの作品でなければなりません。すでに他の場所で特定のチュートリアルを作成していて、私たちと同様のことをしたい場合は、この機会に最初の取り組みを改善してください。 Atlantic.Netは、盗用や既存の作業の再利用を容認しません。

同様に、すべての画像とスクリーンショットも一意である必要があります。

VPSホスティングサービスとVPSホスティング価格の詳細をご覧ください。


Linux
  1. BashForループガイドと例

  2. Linux – USBドライブにLinuxをインストールする場合、最高のパフォーマンスを得るためにフォーマットするにはどのファイルシステムを使用する必要がありますか?

  3. 方法:Atlantic.Net記事のスタイルガイド

  1. システム管理者向けの10のコンテナガイド

  2. Atlantic.NetのフォーマットガイドWhat-IsArticles

  3. Atlantic.NetFAQのために書く

  1. Atlantic.NetがNGINXを選んだ理由

  2. Web ページ内のコードをフォーマットする方法

  3. malloc と free のコード