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

#116 Add tip on --dirtyreload #162

Merged
merged 4 commits into from
Nov 12, 2021
Merged

#116 Add tip on --dirtyreload #162

merged 4 commits into from
Nov 12, 2021

Conversation

planetf1
Copy link
Member

Signed-off-by: Nigel Jones nigel.l.jones+git@gmail.com

When developing documentation it's useful to run mkdocs serve so that pages can be viewed/tested as one is updating

However this rebuild is SLOW - it can take a minute or two, and kicks in at random as pages are updated - usually after a few lines!

By adding the --dirtyreload parameter to mkdocs serve this reload is incremental and reduced to 1-2 seconds.
Deleted pages will not get cleaned up, and it's possible mass restructuring could be problematic. However for incremental content authoring (for example I am working on Dojo day 1) it's a real bonus

Added this tip into the documentation guide (open to suggestions on improved wording)

Signed-off-by: Nigel Jones <nigel.l.jones+git@gmail.com>
@planetf1 planetf1 reopened this Nov 10, 2021
Copy link
Member

@cmgrote cmgrote left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this tip! Just a couple of suggested revisions:

  1. Please use the word and rather than an ampersand (&) for overall documentation consistency.
  2. Please link to the release notes of MkDocs which further describe this option (and provide further links into MkDocs PRs, etc giving even more context): https://www.mkdocs.org/about/release-notes/#support-for-dirty-builds-990

planetf1 and others added 3 commits November 12, 2021 08:56
Signed-off-by: Nigel Jones <nigel.l.jones+git@gmail.com>
Signed-off-by: Nigel Jones <nigel.l.jones+git@gmail.com>
@cmgrote cmgrote merged commit 2afa595 into odpi:main Nov 12, 2021
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 this pull request may close these issues.

None yet

2 participants