Uploaded image for project: 'TinkerPop'
  1. TinkerPop
  2. TINKERPOP-989

Default documentation should be reference/index.html

Details

    • Improvement
    • Status: Closed
    • Minor
    • Resolution: Done
    • 3.1.0-incubating
    • 3.1.4, 3.2.2
    • documentation
    • None

    Description

      Now that we put the docs into folders, the base URL is a directory structure: http://tinkerpop.incubator.apache.org/docs/3.1.1-SNAPSHOT/ ... should we have this default to reference/index.html? I think so.

      Attachments

        Issue Links

          Activity

            I kinda thought it might be nice if we had a documentation landing page at that spot, so we could better guide folks to the documentation they were looking for. As we develop more and more tutorials and external docs start to pop up, the home page won't be able to easily support all that.

            spmallette Stephen Mallette added a comment - I kinda thought it might be nice if we had a documentation landing page at that spot, so we could better guide folks to the documentation they were looking for. As we develop more and more tutorials and external docs start to pop up, the home page won't be able to easily support all that.
            githubbot ASF GitHub Bot added a comment -

            GitHub user spmallette opened a pull request:

            https://github.com/apache/tinkerpop/pull/382

            TINKERPOP-989 Add a landing page for documentation.

            https://issues.apache.org/jira/browse/TINKERPOP-989

            There was no comment on the DISCUSS thread so I assume consensus on this. I've targeted this PR at tp31 as we expect to continue to release on this line and it would be good to have the links to documentation stay consistent for all releasable code lines. There are some tweaks to make when this merges to master as we have more documentation there. I will make those tweaks via CTR and publish after this is all merged in.

            VOTE +1

            You can merge this pull request into a Git repository by running:

            $ git pull https://github.com/apache/tinkerpop TINKERPOP-989

            Alternatively you can review and apply these changes as the patch at:

            https://github.com/apache/tinkerpop/pull/382.patch

            To close this pull request, make a commit to your master/trunk branch
            with (at least) the following in the commit message:

            This closes #382


            commit f1ec0b6e6159dab6833f1f675ddfcd87c4c4d84c
            Author: Stephen Mallette <spmva@genoprime.com>
            Date: 2016-08-12T11:00:55Z

            Add a landing page for documentation.


            githubbot ASF GitHub Bot added a comment - GitHub user spmallette opened a pull request: https://github.com/apache/tinkerpop/pull/382 TINKERPOP-989 Add a landing page for documentation. https://issues.apache.org/jira/browse/TINKERPOP-989 There was no comment on the DISCUSS thread so I assume consensus on this. I've targeted this PR at tp31 as we expect to continue to release on this line and it would be good to have the links to documentation stay consistent for all releasable code lines. There are some tweaks to make when this merges to master as we have more documentation there. I will make those tweaks via CTR and publish after this is all merged in. VOTE +1 You can merge this pull request into a Git repository by running: $ git pull https://github.com/apache/tinkerpop TINKERPOP-989 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/tinkerpop/pull/382.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #382 commit f1ec0b6e6159dab6833f1f675ddfcd87c4c4d84c Author: Stephen Mallette <spmva@genoprime.com> Date: 2016-08-12T11:00:55Z Add a landing page for documentation.
            githubbot ASF GitHub Bot added a comment -

            Github user PommeVerte commented on the issue:

            https://github.com/apache/tinkerpop/pull/382

            +1

            githubbot ASF GitHub Bot added a comment - Github user PommeVerte commented on the issue: https://github.com/apache/tinkerpop/pull/382 +1
            githubbot ASF GitHub Bot added a comment -

            Github user twilmes commented on the issue:

            https://github.com/apache/tinkerpop/pull/382

            VOTE: +1

            githubbot ASF GitHub Bot added a comment - Github user twilmes commented on the issue: https://github.com/apache/tinkerpop/pull/382 VOTE: +1
            githubbot ASF GitHub Bot added a comment -

            Github user asfgit closed the pull request at:

            https://github.com/apache/tinkerpop/pull/382

            githubbot ASF GitHub Bot added a comment - Github user asfgit closed the pull request at: https://github.com/apache/tinkerpop/pull/382

            People

              spmallette Stephen Mallette
              okram Marko A. Rodriguez
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: