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

Document the deployment procedure #356

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

goerz
Copy link

@goerz goerz commented Oct 20, 2019

This should clarify some of the details mentioned in the doctr deploy documentation, specifically what "synchronization" is (--no-sync flag), and how --command fits in.

@goerz
Copy link
Author

goerz commented Oct 20, 2019

Hopefully, I got the procedure right, based on looking over the source code. Let me know if I misunderstood anything.

One question: What is the purpose of the --no-temp-dir flag? It skips the first step, copying the BUILT_DOCS directory, but I can't think of any situation where this would be useful. I think it would cause a crash unless combined with --no-sync. I suppose with --no-temp-dir and --no-sync, a custom --command could take over the entire deployment, but it wouldn't have access to the built documentation (which was stashed away).

This should clarify some of the details mentioned in the `doctr deploy`
documentation, specifically what "synchronization" is (`--no-sync`
flag), and how `--command` fits in.
@asmeurer
Copy link
Member

I don't remember why I added it (see #215). It might have been for the reason you noted so that you can control the deployment yourself if you want. But the stash thing was added later, so it might be broken. It looks like the flag isn't tested, so I'm not surprised if it doesn't work.

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.

2 participants