Uploaded image for project: 'Mesos'
  1. Mesos
  2. MESOS-4588

Set title for documentation webpages.

    Details

      Description

      The HTML we generate for the documentation pages (e.g., https://mesos.apache.org/documentation/latest/authorization/) has an empty <title/> tag. This seems bad: we probably lose search engine karma, it is hard to identify a documentation page in your browser tabs, etc.

        Activity

        Hide
        a10gupta Abhishek Dasgupta added a comment -

        Yes, this looks really bad!! I would like to work on this issue. Can you guide me where are the source code for Documentation HTML ? Are they in same mesos github repository or any other repository?

        Show
        a10gupta Abhishek Dasgupta added a comment - Yes, this looks really bad!! I would like to work on this issue. Can you guide me where are the source code for Documentation HTML ? Are they in same mesos github repository or any other repository?
        Hide
        neilc Neil Conway added a comment -

        Documentation is written in Markdown format (markdown files are in docs/ subdirectory in the Mesos git repo), and then converted to HTML by a script (site/Rakefile). Markdown => HTML conversion is done by rdiscount, as configured by site/config.rb. You'd want to find a way to configure the title of the generated HTML; not sure how to do that offhand.

        Show
        neilc Neil Conway added a comment - Documentation is written in Markdown format (markdown files are in docs/ subdirectory in the Mesos git repo), and then converted to HTML by a script ( site/Rakefile ). Markdown => HTML conversion is done by rdiscount, as configured by site/config.rb . You'd want to find a way to configure the title of the generated HTML; not sure how to do that offhand.
        Hide
        a10gupta Abhishek Dasgupta added a comment -

        Hi Neil,
        We have to set the title field in each documentation file from docs/ subdirectory to configure the title of generated HTML. I am setting the title as per the name of each documentation file. Will it be okay?

        Show
        a10gupta Abhishek Dasgupta added a comment - Hi Neil, We have to set the title field in each documentation file from docs/ subdirectory to configure the title of generated HTML. I am setting the title as per the name of each documentation file. Will it be okay?
        Hide
        a10gupta Abhishek Dasgupta added a comment -

        Please find the patch at https://reviews.apache.org/r/43328/

        Will someone shepherd this issue?

        Show
        a10gupta Abhishek Dasgupta added a comment - Please find the patch at https://reviews.apache.org/r/43328/ Will someone shepherd this issue?
        Hide
        a10gupta Abhishek Dasgupta added a comment -

        Please find two more patches on this issue at:
        https://reviews.apache.org/r/43715/
        https://reviews.apache.org/r/43716/

        Show
        a10gupta Abhishek Dasgupta added a comment - Please find two more patches on this issue at: https://reviews.apache.org/r/43715/ https://reviews.apache.org/r/43716/
        Hide
        adam-mesos Adam B added a comment -

        Still two patches remaining for updating endpoint docs, but I committed this one:

        commit 9d8722f9650e9b47e759a9600b43b1c2adcf1350
        Author: Abhishek Dasgupta <a10gupta@linux.vnet.ibm.com>
        Date: Sat Feb 27 04:28:50 2016 -0800

        Added a title to all documentation markdown files.

        All the documentation markdown files are updated with a title so that
        UI shows the title on browser.

        Review: https://reviews.apache.org/r/43328/

        Show
        adam-mesos Adam B added a comment - Still two patches remaining for updating endpoint docs, but I committed this one: commit 9d8722f9650e9b47e759a9600b43b1c2adcf1350 Author: Abhishek Dasgupta <a10gupta@linux.vnet.ibm.com> Date: Sat Feb 27 04:28:50 2016 -0800 Added a title to all documentation markdown files. All the documentation markdown files are updated with a title so that UI shows the title on browser. Review: https://reviews.apache.org/r/43328/
        Hide
        adam-mesos Adam B added a comment -

        commit 7d33bace1c956497fd6992917ffb67aa96fe30f1
        Author: Abhishek Dasgupta <a10gupta@linux.vnet.ibm.com>
        Date: Tue Mar 1 16:38:48 2016 -0800

        Added title to every endpoint markdown doc.

        Review: https://reviews.apache.org/r/43716/

        commit 01d472d8c0e28e917c7d58f61588f4d6069dcd14
        Author: Abhishek Dasgupta <a10gupta@linux.vnet.ibm.com>
        Date: Tue Mar 1 16:36:57 2016 -0800

        Updated support/generate-endpoint-help.py to include title.

        The support/generate-endpoint-help.py script now adds a title to every
        generated endpoint markdown file.

        Review: https://reviews.apache.org/r/43715/

        Show
        adam-mesos Adam B added a comment - commit 7d33bace1c956497fd6992917ffb67aa96fe30f1 Author: Abhishek Dasgupta <a10gupta@linux.vnet.ibm.com> Date: Tue Mar 1 16:38:48 2016 -0800 Added title to every endpoint markdown doc. Review: https://reviews.apache.org/r/43716/ commit 01d472d8c0e28e917c7d58f61588f4d6069dcd14 Author: Abhishek Dasgupta <a10gupta@linux.vnet.ibm.com> Date: Tue Mar 1 16:36:57 2016 -0800 Updated support/generate-endpoint-help.py to include title. The support/generate-endpoint-help.py script now adds a title to every generated endpoint markdown file. Review: https://reviews.apache.org/r/43715/

          People

          • Assignee:
            a10gupta Abhishek Dasgupta
            Reporter:
            neilc Neil Conway
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development