Skip to content

Commit

Permalink
Link well-formatted page to styleguide for example (#1361)
Browse files Browse the repository at this point in the history
* Link well-formatted page to styleguide for example

* Clarify

* Note on consistent formattign

* update readme
  • Loading branch information
rkronberg authored Jul 13, 2022
1 parent e3766eb commit edca1e1
Show file tree
Hide file tree
Showing 3 changed files with 152 additions and 133 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,24 @@
# Docs CSC

This repository contains master data for
[Docs CSC](https://docs.csc.fi) which is in sync with 'master' branch.
If you're looking for CSC user guides, click [here](https://docs.csc.fi).
This repository contains master data for [Docs CSC](https://docs.csc.fi),
which is in sync with "master" branch. If you're looking for CSC user guides,
click [here](https://docs.csc.fi).

## Creating issues

If you find that anything is wrong, badly written or missing, please
help us to fix it. We try to make this guide as good as possible. We
appreciate your help.

The easiest way to create issues is to go to a page that you want to
create an issue about, and click 'File a bug report for this
article'. More general issues can be submitted through GitHubs [Issues tab](https://github.com/CSCfi/csc-user-guide/issues)
The easiest way to create issues is to go to the source file that you want
to create an issue about, click the appropriate line number and select
"Reference in new issue". Make sure you are displaying the "source blob",
not the rendered version of the page. More general issues can be submitted
through GitHub's [Issues tab](https://github.com/CSCfi/csc-user-guide/issues).
Creating an Issue requires a GitHub account.

[Contributing](CONTRIBUTING.md)
## How to contribute

[Style guide](STYLEGUIDE.md)

[Frequently asked questions](FAQ.md)
* [Contributing](CONTRIBUTING.md)
* [Style guide](STYLEGUIDE.md)
* [Frequently asked questions](FAQ.md)
12 changes: 10 additions & 2 deletions STYLEGUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,16 @@

## General help
- [Markdown syntax guide](https://www.markdownguide.org/tools/mkdocs/)
- Also some special markup possible, e.g. coloured highlight boxes (please look at Markdown source for examples, and use preview)
- Also some special markup possible, e.g. admonitions (colored highlight boxes). Please look at Markdown source for examples, and use preview
- When in doubt, check how other pages are formatted
- An example of a well-formatted page is the one on [disk areas](https://docs.csc.fi/computing/disk/)
([source file](https://github.com/CSCfi/csc-user-guide/blob/master/docs/computing/disk.md)),
including examples on how to format code blocks, tables and admonitions
- Note that pages under a certain category may have a unified formatting that should be followed
- For example, application pages should have **Available** (which versions and on which systems),
**License** (free or somehow restricted), **Usage** (how to load module, example batch scripts),
**References** (what should be cited) and **More information** (links to e.g official documentation)
headers, in that order.

## Organizing content
- Try to make standalone articles with a good name (user knows to select it from the left menu)
Expand Down Expand Up @@ -63,7 +71,7 @@
## Images, linked documents
- [See FAQ for details](FAQ.md#how-to-add-an-image).
- Put all images in `/img` folder in docs root
- Put large files in Allas bucket docs-files (write access with `project_2001659`), e.g. [https://a3s.fi/docs-files/README.md]( https://a3s.fi/docs-files/README.md)
- Put large files in Allas bucket docs-files (write access with `project_2001659`), e.g. [https://a3s.fi/docs-files/README.md](https://a3s.fi/docs-files/README.md)
- New files easy to share with `a-publish your-file.tgz -b docs-files`

## Syntax highlighting
Expand Down
Loading

0 comments on commit edca1e1

Please sign in to comment.