Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Switch to Wyam for documentation #1932

Closed
gep13 opened this issue Nov 23, 2019 · 3 comments
Closed

Switch to Wyam for documentation #1932

gep13 opened this issue Nov 23, 2019 · 3 comments
Assignees
@gep13
Labels
documentation stale

Comments

@gep13
Copy link
Member

gep13 commented Nov 23, 2019

After a discussion on Slack, the decision has been taken to move away from ReadTheDocs, in favour of Wyam, and pushing the generated output to GitHub Pages.
@gep13 gep13 self-assigned this Nov 23, 2019
@gep13
Copy link
Member Author

gep13 commented Nov 23, 2019

@arturcic @JakeGinnivan @dazinator @asbjornu

gep13 added a commit to gep13/GitVersion that referenced this issue Nov 24, 2019
@gep13
(GitToolsGH-1932) Remove mkdocs file
f844e70 
This will no longer be required once we move all docs over to Wyam.
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 24, 2019
@gep13
(GitToolsGH-1932) Change folder structure
6db5153 
Wyam has a couple of conventions with regard to "where" files are.
Update the folder structure to match what is expected.
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 24, 2019
@gep13
(GitToolsGH-1932) Add Wyam Addin and Tool
af6508d
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 25, 2019
@gep13
(GitToolsGH-1932) Remove mkdocs file
b208013 
This will no longer be required once we move all docs over to Wyam.
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 25, 2019
@gep13
(GitToolsGH-1932) Change folder structure
b5ae116 
Wyam has a couple of conventions with regard to "where" files are.
Update the folder structure to match what is expected.
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 25, 2019
@gep13
(GitToolsGH-1932) Add Wyam Addin and Tool
abfca01
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 26, 2019
@gep13
(GitToolsGH-1932) Remove mkdocs file
97e4419 
This will no longer be required once we move all docs over to Wyam.
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 26, 2019
@gep13
(GitToolsGH-1932) Change folder structure
7e148ea 
Wyam has a couple of conventions with regard to "where" files are.
Update the folder structure to match what is expected.
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 26, 2019
@gep13
(GitToolsGH-1932) Add Wyam Addin and Tool
7eb7044
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 26, 2019
@gep13
(GitToolsGH-1932) Fix broken unit tests
258d792 
Removed unit test referencing the mkdocs.yml file, as this is no longer
required.
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 26, 2019
@gep13
(GitToolsGH-1932) Remove deleted file from sln file
4720a8f 
The mkdocs.yml file is no longer required, and therefore shouldn't be
included in the sln file.
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 26, 2019
@gep13
(GitToolsGH-1932) Update readme information about docs
cf4df78
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 26, 2019
@gep13
(GitToolsGH-1932) Add Wyam Preview task
aae9c92 
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.
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 26, 2019
@gep13
(GitToolsGH-1932) Fix paths to image files
c038e1e 
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.
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 27, 2019
@gep13
(GitToolsGH-1932) Remove mkdocs file
b1c0643 
This will no longer be required once we move all docs over to Wyam.
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 27, 2019
@gep13
(GitToolsGH-1932) Change folder structure
2496c13 
Wyam has a couple of conventions with regard to "where" files are.
Update the folder structure to match what is expected.
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 27, 2019
@gep13
(GitToolsGH-1932) Add Wyam Addin and Tool
304bcd0
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 27, 2019
@gep13
(GitToolsGH-1932) Fix broken unit tests
e9c3312 
Removed unit test referencing the mkdocs.yml file, as this is no longer
required.
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 27, 2019
@gep13
(GitToolsGH-1932) Remove deleted file from sln file
b614c28 
The mkdocs.yml file is no longer required, and therefore shouldn't be
included in the sln file.
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 27, 2019
@gep13
(GitToolsGH-1932) Update readme information about docs
bb0fa58
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 27, 2019
@gep13
(GitToolsGH-1932) Add Wyam Preview task
df3c990 
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.
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 27, 2019
@gep13
(GitToolsGH-1932) Fix paths to image files
8ae4278 
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.
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 27, 2019
@gep13
(GitToolsGH-1932) Initial ordering of top level pages
ccf55e9 
More work is needed here, but this makes the top level pages match the
order that is in the current documentation.
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 27, 2019
@gep13
(GitToolsGH-1932) Add missing wyam.cake file
8f07d20 
The wyam.cake file was not included in the original commit, as it was
being ignored in the .gitignore file.
gep13 added a commit to gep13/GitVersion that referenced this issue Nov 27, 2019
@gep13
(GitToolsGH-1932) Add favicon for GitVersion
3bb7dcd
gep13 added a commit to gep13/GitVersion that referenced this issue Dec 1, 2019
@gep13
(GitToolsGH-1932) Add configuration for editing md files
70f1d1e 
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.
gep13 added a commit to gep13/GitVersion that referenced this issue Dec 1, 2019
@gep13
(GitToolsGH-1932) Fix linting errors for top level pages
054df5a
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Remove deleted file from sln file
1476c82 
The mkdocs.yml file is no longer required, and therefore shouldn't be
included in the sln file.
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Update readme information about docs
30ddc04
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Add Wyam Preview task
aa9080f 
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.
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Fix paths to image files
8ce73e5 
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.
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Initial ordering of top level pages
83e7b47 
More work is needed here, but this makes the top level pages match the
order that is in the current documentation.
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Add missing wyam.cake file
79da608 
The wyam.cake file was not included in the original commit, as it was
being ignored in the .gitignore file.
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Add favicon for GitVersion
b5cf84a
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Add configuration for editing md files
d7a54ae 
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.
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Fix linting errors for top level pages
28d9b0f
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Fix linting and ordering in usage section
fc0b595
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Linting and ordering of build server section
9fa054c
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Additional formatting
0db1cee 
Remove unnecessary file
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Linting and ordering of branching strategy
1772a1d
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Linting and ordering of more info section
f69bd7d
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Linting and ordering versioning mode section
81f9255
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Fix page navigations
5a242ef
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Fix generation of API docs
c51aadf
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Fix page title
f5098a7
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Move readme to correct location
af2cb2c
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Use correct command
82d4df2
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Add config.wyam
c48437a 
To control the inclusion of 2nd level headers in the "Edit Content"
section of the docs pages.
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Minor updates to descriptions
3fee455
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Add info, warning and danger callouts
405b8bb
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) First stab at publishing docs
1333e08 
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.
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Add info callout to tip
2724ad7
arturcic pushed a commit that referenced this issue Dec 19, 2019
@gep13 @arturcic
(GH-1932) Fix criteria for publishing documentation
6c20b8d 
Should only run when running on an Azure Pipelines Windows Build Agent,
and not when it is a PR.
@stale
Copy link

stale bot commented Feb 21, 2020

This issue has been automatically marked as stale because it has not had recent activity. After 30 days from now, it will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Feb 21, 2020
@arturcic
Copy link
Member

I think we can close this one

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gep13 gep13

Labels
documentation stale
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@gep13 @arturcic