Uploaded image for project: 'Beam'
  1. Beam
  2. BEAM-12777

Stable URL for "current" API Documentation

Details

    • Improvement
    • Status: Resolved
    • P2
    • Resolution: Resolved
    • None
    • 2.37.0
    • website
    • None

    Description

      Discussion: https://lists.apache.org/thread.html/rc23610839204f2bba1ea148885ef9f496a3087a47d7bb25662a46bc5%40%3Cdev.beam.apache.org%3E

      Summary of the proposal:

      """
      You may have noticed that our API Documentation could really use some SEO. It's possible to search for Beam APIs (e.g. "beam dataframe read_csv" [1] or "beam java ParquetIO" [2]) and you will be directed to some documentation, but it almost always takes you to an old version. I think this could be significantly improved if we just make one change: rather than making https://beam.apache.org/releases/javadoc/current redirect to the latest release, we should just always stage the latest documentation there.

      To be clear I'm not 100% sure this will help. I haven't talked to any search engineers or SEO experts about it. I'm just looking at other projects as a point of reference. I've found that I never have trouble finding the latest pandas documentation (e.g. "pandas read_csv" [3]) since it always directs to "pandas-docs/stable/" rather than a particular version number.

      We should also make sure the version number shows up in the page title, it looks like this isn't the case for Python right now.
      """

      Attachments

        Activity

          People

            Mike Hernandez Mike Hernandez
            altay Ahmet Altay
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0h
                0h
                Logged:
                Time Spent - 11h 10m
                11h 10m