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.

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

Host the most recent version of the FakeItEasy docs on the FakeItEasy website #59

Closed
Tracked by #52
blairconrad opened this issue Nov 29, 2022 · 1 comment · Fixed by #60
Closed
Tracked by #52

Host the most recent version of the FakeItEasy docs on the FakeItEasy website #59

blairconrad opened this issue Nov 29, 2022 · 1 comment · Fixed by #60
Assignees

Comments

@blairconrad
Copy link
Member

No description provided.

@blairconrad blairconrad mentioned this issue Nov 29, 2022
9 tasks
@blairconrad
Copy link
Member Author

blairconrad commented Nov 29, 2022

Steps for adding the docs:

  1. check out FakeItEasy (I used master, since its docs have the latest content and the tools for building using material for mkdocs and mike)
  2. ensure the proper python packages are installed (feel free to use a virtual environment):
    pip install --requirement docs/requirements.txt
  3. check out fakeiteasy.github.io
  4. create host-docs branch from upstream/master. Do not switch to it. Stay on master
  5. add the docs
    mike deploy 7.3.1 stable --branch host-docs --prefix docs --update-aliases --config-file ..\FakeItEasy\mkdocs.yml

this will add docs for 7.3.1 with the alias "stable" pointing at them, and commit on the host-analyzer-docs branch

As a bonus:

mike set-default stable --branch host-docs --prefix docs --config-file ..\FakeItEasy\mkdocs.yml

to make "stable" the default branch, so we can visit https://fakeiteasy.github.io/docs

We shouldn't need to "set-default" in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant