602/documentation framework #681
Conversation
Still missing quite a lot of stuff like analytics and deployment scripts.
Codecov Report
@@ Coverage Diff @@
## develop #681 +/- ##
===========================================
+ Coverage 56.77% 59.68% +2.91%
===========================================
Files 122 151 +29
Lines 4053 5155 +1102
===========================================
+ Hits 2301 3077 +776
- Misses 1752 2078 +326
Continue to review full report at Codecov.
|
| @@ -0,0 +1,6 @@ | |||
| --- | |||
| title: "{{ replace .Name "-" " " | title }}" | |||
There was a problem hiding this comment.
what is this .Name property and why do we replace "-"?
There was a problem hiding this comment.
This just means that then you create a new page using the hugo new folder/some-file.md command, it creates a new page for you with the title Some file (space instead of -).
Example:
|
|
||
| ##### `Error: Unable to locate config file or config directory. Perhaps you need to create a new site.` | ||
|
|
||
| What is your working directory? It should be `monkey/docs`. |
There was a problem hiding this comment.
maybe this could be avoided by explicitly specifying this in all cmd examples? Like instead of "Run hugo new folder/page.md." we could use "Run hugo new monkey/docs/folder/page.md"
There was a problem hiding this comment.
I'd rather we not, because if you run that command inside the working dir it will work but not like you wanted
|
|
||
| ##### `failed to extract shortcode: template for shortcode "children" not found` | ||
|
|
||
| Have you ran `git submodule update`? |
There was a problem hiding this comment.
Could be moved to requirements?
There was a problem hiding this comment.
Can be because theme is updated while working, so updated the title
|
|
||
| #### Serve the documentation locally | ||
|
|
||
| Run `hugo server -D`. The server will be available locally at `http://localhost:1313/infectionmonkey/docs/`. You can change the content/theme and the site will refresh automatically to reflect your changes. |
There was a problem hiding this comment.
For me this is 404. The correct link is http://localhost:1313/.
There was a problem hiding this comment.
Nice catch, fixed
Added accounts and security page
required for static files to work
Made the homepage a lot more elegant with some custom HTML (new shortcode)
| @@ -0,0 +1,12 @@ | |||
| --- | |||
There was a problem hiding this comment.
I don't know if we should have this page in prod. This adds nothing that config page doesn't explain
There was a problem hiding this comment.
I'd rather leave this section online and wait for your config PR - then we could improve this page (with example values and such)
There was a problem hiding this comment.
why not push it as draft?
| @@ -0,0 +1,10 @@ | |||
| --- | |||
There was a problem hiding this comment.
I'm not sure we should have this page in prod. as this adds nothing that config page doesn't explain
There was a problem hiding this comment.
I'd rather leave this section online and wait for your config PR - then we could improve this page (with example values and such)
There was a problem hiding this comment.
why not push it as draft?
What is this?
Fixes #602.
Checklist
Proof that it works
WIP picture:
Changes
Are the commit messages enough? If not, elaborate.