[jira] [Comment Edited] (FLINK-4318) Make master docs build target version-specific

["Maximilian Michels (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/FLINK-4318?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15415154#comment-15415154 ] 

Maximilian Michels edited comment on FLINK-4318 at 8/10/16 11:51 AM:
---------------------------------------------------------------------

The docs are built from a list of Git branches. {{flink-docs-master}} is built from {{master}}, {{flink-docs-release-1.1}} is built from {{release-1.1}}.

We could create the release branch earlier to kick off the documentation builds. Or, we could add an additional label to the Git branches list that is used instead of the branch name. To incorporate both of your suggestions, we could have something like

\# Git branch, label
(master, master)
(master, release-1.2)
(release-1.1, release-1.1)
(release-1.0, release-1.0)
...


was (Author: mxm):
The docs are built from a list of Git branches. {{flink-docs-master}} is built from {{master}}, {{flink-docs-release-1.1}} is built from {{release-1.1}}.

We could create the release branch earlier to kick off the documentation builds. Or, we could add an additional label to the Git branches list that is used instead of the branch name. To incorporate both of your suggestions, we could have something like

# Git branch, label
(master, master)
(master, release-1.2)
(release-1.1, release-1.1)
(release-1.0, release-1.0)
...

> Make master docs build target version-specific
> ----------------------------------------------
>
>                 Key: FLINK-4318
>                 URL: https://issues.apache.org/jira/browse/FLINK-4318
>             Project: Flink
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 1.1.0
>            Reporter: Ufuk Celebi
>
> Snapshots docs are found at {{.../flink-docs-master}}. This is relative to when the link is posted. We often do this on the mailing lists, but the docs evolve over time. This can lead to dead links or page content which don't match the original content (when the link was posted).
> I would like to move the snapshot docs to their respective version, e.g. {{.../flink-docs-release-1.2}} before we do the actual release. This way, we will hopefully have less broken links and archived emails will make more sense. Furthermore, we will have more freedom when re-organizing pages.
> The current {{master}} could point to {{.../flink-docs-release-1.1}}.
> [~mxm] what do you think?



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)