-
Notifications
You must be signed in to change notification settings - Fork 6
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
feat(docuploader): add destination-prefix option #26
Conversation
The format option will be used when uploading DocFX YAML. We need to distinguish HTML docs vs DocFX YAML. Then, another job will convert the YAML to HTML. In a future PR, I'll add the ability to edit the metadata to change the format to HTML. That way, when we re-upload the result, it will have the "correct" metadata format.
I'm not sure if it's a good idea to have this option. Instead can we always upload html files? |
I love this idea. One of the original goals was to try getting to an intermediary format that could be re-generated into HTML as the template on cloudsite changes. By storing this in YAML instead of HTML, we can re-generate any time we want with different visuals. |
I'm not opposed to have a capability of only re-generating the HTML from yaml files. I don't feel quite right to have this option and metadata. How about just to have |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I prefer --destination-prefix
option
I may miss the big picture, so I could be convinced if there's a reason to add |
I switched it to The risk of this is that each client library will be responsible for setting the right |
The prefix option will be used when uploading DocFX YAML. We need to
distinguish HTML docs vs DocFX YAML. Then, another job will convert the
YAML to HTML. This way, all DocFX tarballs can start with
docfx-
and we canstrip that prefix when uploading the resulting HTML.