(GH-1932) Convert to Wyam for Documentation #1935
Conversation
gep13
force-pushed
the
feature/GH-1932
branch
2 times, most recently
from
abfca01 to
cf4df78
Compare
|
Progress being made...
|
gep13
force-pushed
the
feature/GH-1932
branch
from
c038e1e to
8f07d20
Compare
|
@arturcic @asbjornu @AdmiringWorm would you all be able to take this branch for a spin, and provide some feedback on the current status of the conversion to Wyam? Here is the main page:
You should be able to run the docs locally by running: |
|
@gep13 the links in the docs, do not work, they are pointing to *.md files, but if I remove the md in the url they work Have a look here for example http://localhost:5080/GitVersion/docs/usage/usage |
gep13
force-pushed
the
feature/GH-1932
branch
from
19b6883 to
08f6143
Compare
|
@arturcic I have updated the pages with the correct links. Can you have another look at this? |
|
I'll have a look |
|
@arturcic I was planning on hosting this on GitHub Pages. I still have another task to add to the Wyam.cake file which would do that, but I wanted to check that everyone was happy with what I have before taking that step. |
Go for it! |
This will no longer be required once we move all docs over to Wyam.
Wyam has a couple of conventions with regard to "where" files are. Update the folder structure to match what is expected.
Removed unit test referencing the mkdocs.yml file, as this is no longer required.
The mkdocs.yml file is no longer required, and therefore shouldn't be included in the sln file.
This will help with getting the docs setup, as it will allow viewing the generated docs locally with live reload, to allow adjustments to be made.
These were moved as part of the refactoring of the docs. This was highlighted when the build was failing, since the included files in the nuget packages couldn't be found.
More work is needed here, but this makes the top level pages match the order that is in the current documentation.
The wyam.cake file was not included in the original commit, as it was being ignored in the .gitignore file.
Add vertical ruler to make it easier to see where MD files should start a new line, and also start controlling which rules are triggered by markdownlint.
Remove unnecessary file
To control the inclusion of 2nd level headers in the "Edit Content" section of the docs pages.
Some had to be updated, others needed to have the .md removed from the link.
gep13
force-pushed
the
feature/GH-1932
branch
from
695aa22 to
4c13a43
Compare
|
I'd like to set this up with https://gitversion.net/ as a custom URL once it's done. GitHub Pages would be perfect. 👌 |
This may well break, and we won't be able to test this until merged since it isn't meant to work on PR builds.
Should only run when running on an Azure Pipelines Windows Build Agent, and not when it is a PR.
|
I merged it, let's give it a try |
Still lots of work to do here, but thought I would get started...