Skip to content

Commit aa01d48

Browse files
authored
Make GitHub Pages configuration more accesible (#214)
- Add a style to align in the middle vertically - Mention more explicitly "Configure GitHub" is about Settings - Add a section about Pages in "Configure GitHub"
2 parents c87225e + 2f901ca commit aa01d48

File tree

3 files changed

+13
-1
lines changed

3 files changed

+13
-1
lines changed

docs/_css/style.css

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,8 @@ a.external:hover::after, a.md-nav__link[href^="https:"]:hover::after {
6868
.md-typeset .md-annotation__index {
6969
width: 4ch;
7070
}
71+
72+
/* Align vertically */
73+
.align-middle {
74+
vertical-align: middle;
75+
}

docs/_img/settings.png

1.76 KB
Loading

docs/user-guide/start-a-new-project/configure-github.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
The generated templates make some assumptions about how the GitHub repository
44
is configured. Here is a summary of changes you should do to the repository
5-
to make sure everything works as expected.
5+
![Settings](../../_img/settings.png){: .align-middle } to make sure everything
6+
works as expected.
67

78
## Issues
89

@@ -154,3 +155,9 @@ Import the following
154155

155156
The basic code configuration should be generate using
156157
[repo-config](https://frequenz-floss.github.io/frequenz-repo-config-python/).
158+
159+
## GitHub Pages
160+
161+
No special configuration is needed for GitHub Pages, but you need to initialize
162+
the `gh-pages` branch. You can read how to do this in the [Initialize GitHub
163+
Pages](index.md#initialize-github-pages.md) section.

0 commit comments

Comments
 (0)