Add instructions about READMEs to new Diffusion basic editor

Summary: Provide contextual, in-app documentation about README files.

Test Plan: {F44181}

Reviewers: chad, btrahan

Reviewed By: btrahan

CC: aran

Differential Revision: https://secure.phabricator.com/D6033
This commit is contained in:
epriestley
2013-05-24 12:38:27 -07:00
parent 1430c2c449
commit c5546a1f15
7 changed files with 116 additions and 52 deletions

View File

@@ -98,7 +98,9 @@ final class DiffusionRepositoryEditBasicController extends DiffusionController {
->appendChild(
id(new AphrontFormSubmitControl())
->setValue(pht('Save'))
->addCancelButton($edit_uri));
->addCancelButton($edit_uri))
->appendChild(id(new PHUIFormDividerControl()))
->appendRemarkupInstructions($this->getReadmeInstructions());
$content[] = $form;
@@ -111,5 +113,21 @@ final class DiffusionRepositoryEditBasicController extends DiffusionController {
));
}
private function getReadmeInstructions() {
return pht(<<<EOTEXT
You can also create a `README` file at the repository root (or in any
subdirectory) to provide information about the repository. These formats are
supported:
| File Name | Rendered As... |
|-----------------|----------------|
| `README` | Plain Text |
| `README.txt` | Plain Text |
| `README.remarkup` | Remarkup |
| `README.md` | Remarkup |
| `README.rainbow` | \xC2\xA1Fiesta! |
EOTEXT
);
}
}