Page MenuHomeSoftware Heritage
Create Task
Maniphest T620

face lift for the API doc page
Closed, MigratedEdits Locked
Actions

Description

The API doc page (currently auth-protected) is pretty decent at listing all the API end points, but need a face lift. It doesn't look at all like the rest of our website (neither the main website, nor the wiki, nor anything really).
We need to apply a CSS to it, so that at least the main elements of our visual identity are present.

Related Objects
Search...

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes
zack updated the task description. (Show Details)Jan 12 2017, 10:02 AM
ardumont added a subscriber: ardumont.Jan 13 2017, 5:50 PM

Apply better style to differentiate between deprecated, upcoming, and current api endpoints (cf. T631)

ardumont mentioned this in T630: add support for an introductory paragraph to the API doc page.Jan 16 2017, 5:47 PM
ardumont moved this task from Restricted Project Column to Restricted Project Column on the Restricted Project board.Jan 18 2017, 3:02 PM
ardumont claimed this task.Jan 20 2017, 4:15 PM
ardumont mentioned this in rDWAPPS554f1f63804e: Unify font-family with www.s.o.Jan 20 2017, 6:09 PM
ardumont mentioned this in rDWAPPS9342d08503f5: apidoc style: Improve default global font-size.Jan 23 2017, 4:10 PM
ardumont mentioned this in rDWAPPS3458b3a34078: apidoc: Add the toc header in main menu.
ardumont mentioned this in rDWAPPS4fdd2f76c840: apidoc style: Slightly decrease pre font's size.
ardumont mentioned this in rDWAPPSbc6720a5a020: apidoc: Fix typo.
ardumont mentioned this in rDWAPPSf8e09d2e2426: apidoc: Make the main entry point of the webapp be api's documentation.
ardumont mentioned this in rDWAPPS9186ba06de8b: style: Add swh's logo on the menu header.
ardumont mentioned this in rDWAPPSfabb7532bc58: style: Move title below menu.
ardumont mentioned this in rDWAPPSd7a96b09b3c9: style: Decrease title to a reasonable size.
ardumont mentioned this in rDWAPPSfbd63df1593b: style: Add gradient bottom border to header menu.
ardumont mentioned this in rDWAPPS19ab450b31fa: style: Add header menu to the top of the page.
ardumont mentioned this in rDWAPPS3e7e72c859f8: style: Unify link behavior with www.s.o.
ardumont mentioned this in rDWAPPSb83075ad8d3c: style: Unify SWH title with 2 fonts as in www.s.o.
ardumont mentioned this in rDWAPPSd6c4c71c786a: style: Make the menu fixed when scrolling.
ardumont mentioned this in rDWAPPSf76514e12771: style: Slightly increase the font-size.
ardumont mentioned this in rDWAPPSe678d37a41e5: style: font color unification.
ardumont added a comment.EditedJan 23 2017, 6:34 PM

Current commits listed before are current deployed on production for demo.

There remains some fixes:

  • internal links are not rendered properly with the fixed menu (P127).
  • when screen size is way small, the gradient disappears
  • when screen size is way small, the menu should be displayed on right (as in www.s.o) and not vertically, as it is currently

Some evolution remains to implement, as per www.s.o's:

  • Menu should take all the width space
  • /api/1/ needs to be improved on upcoming task style
  • /api/1/ needs to be improved in general (it's ugly)
  • Add breadcrumbs as in www.s.o
  • Add back to top link in fixed footer
ardumont mentioned this in rDWAPPSa9e8184f67c2: style: Remove grey-ish background color.Jan 23 2017, 7:04 PM
ardumont mentioned this in rDWAPPS8d6d9d2e1ce1: style: Make the menu fill the screen.Jan 23 2017, 7:32 PM
ardumont mentioned this in rDWAPPSee5b8cdb224e: style: Align the navigator bar to the right.
ardumont mentioned this in rDWAPPS012168efe802: style: Fix in-page links covered by navbar.
ardumont mentioned this in rDWAPPSbd2a3c434eca: style: Add back to top link.Jan 23 2017, 7:55 PM
ardumont mentioned this in rDWAPPSb4c36306c72c: apidoc: Fix empty line.Jan 23 2017, 7:58 PM
ardumont mentioned this in rDWAPPSfca1bee22ad5: style: Fix in-page links covered by navbar.Jan 23 2017, 8:06 PM
ardumont mentioned this in rDWAPPS7585260e8776: style: Remove border on left and right for the fixed menu.Jan 24 2017, 3:27 PM
ardumont mentioned this in rDWAPPS195a90f8cfb7: style: Use red-ish border for apidoc table.
ardumont mentioned this in rDWAPPS5c21c7fa6f89: apidoc: List endpoints in a responsive table.
ardumont mentioned this in rDWAPPS8510e8c355c2: apidoc: Fix positioning glitch between fixed header and datatable.
ardumont mentioned this in rDWAPPS0fae9f713cb9: apidoc: Fix rendering glitch with ~.
ardumont mentioned this in rDWAPPS47a5a24f0110: apidoc: Unify font color for upcoming/deprecated rows.
ardumont mentioned this in rDWAPPS54de2bec5dc5: apidoc: Add breadcrumb links.
ardumont mentioned this in rDWAPPSa01d7beeeaba: style: Remove duplicated a entry.
ardumont mentioned this in rDWAPPS03258a292fe4: apidoc: Rename page titles with a better description.
ardumont mentioned this in rDWAPPSc29a1193dd62: style: Remove border on left and right for the fixed menu.Jan 24 2017, 3:37 PM
ardumont mentioned this in rDWAPPSf151bfaa47cf: style: Use red-ish border for apidoc table.
ardumont mentioned this in rDWAPPSc81e8888a2b3: apidoc: List endpoints in a responsive table.
ardumont mentioned this in rDWAPPSd3ea1d5213b9: apidoc: Fix rendering glitch with ~.
ardumont mentioned this in rDWAPPS152737fcf612: apidoc: Fix positioning glitch between fixed header and datatable.
ardumont mentioned this in rDWAPPS115e6a917d01: apidoc: Unify font color for upcoming/deprecated rows.
ardumont mentioned this in rDWAPPSe89686a2ddeb: apidoc: Add breadcrumb links.
ardumont mentioned this in rDWAPPS973c250b2f21: style: Remove duplicated a entry.
ardumont mentioned this in rDWAPPS7779471fc71a: apidoc: Rename page titles with a better description.
ardumont added a comment.Jan 24 2017, 3:43 PM

Mmph, commits are mentioned twice since i rebased after roberto's fix commit.
Anyway, deployed!

ardumont mentioned this in rDWAPPScf36f86eb7a7: apidoc: Remove /browse from header menu.Jan 25 2017, 1:34 PM
ardumont mentioned this in rDWAPPS243cff6d3491: apidoc: Rename upper breadcrumb from Home to API.
ardumont mentioned this in rDWAPPS1559b56bb633: apidoc: Do not present upcoming endpoint documentation.
ardumont mentioned this in rDWAPPS7fbf38c5513a: apidoc: Link in header menu points to archive.
ardumont mentioned this in rDWAPPS532291c6505b: apidoc: Add archive label text to swh logo.
ardumont closed this task as Resolved.Jan 25 2017, 1:41 PM
ardumont mentioned this in R65:554f1f63804e: Unify font-family with www.s.o.Feb 23 2019, 1:55 AM
ardumont mentioned this in R65:9342d08503f5: apidoc style: Improve default global font-size.
ardumont mentioned this in R65:3458b3a34078: apidoc: Add the toc header in main menu.
ardumont mentioned this in R65:4fdd2f76c840: apidoc style: Slightly decrease pre font's size.
ardumont mentioned this in R65:bc6720a5a020: apidoc: Fix typo.
ardumont mentioned this in R65:f8e09d2e2426: apidoc: Make the main entry point of the webapp be api's documentation.
ardumont mentioned this in R65:9186ba06de8b: style: Add swh's logo on the menu header.
ardumont mentioned this in R65:fabb7532bc58: style: Move title below menu.
ardumont mentioned this in R65:d7a96b09b3c9: style: Decrease title to a reasonable size.
ardumont mentioned this in R65:fbd63df1593b: style: Add gradient bottom border to header menu.
ardumont mentioned this in R65:19ab450b31fa: style: Add header menu to the top of the page.
ardumont mentioned this in R65:3e7e72c859f8: style: Unify link behavior with www.s.o.
ardumont mentioned this in R65:b83075ad8d3c: style: Unify SWH title with 2 fonts as in www.s.o.
ardumont mentioned this in R65:d6c4c71c786a: style: Make the menu fixed when scrolling.
ardumont mentioned this in R65:f76514e12771: style: Slightly increase the font-size.
ardumont mentioned this in R65:e678d37a41e5: style: font color unification.
ardumont mentioned this in R65:a9e8184f67c2: style: Remove grey-ish background color.
ardumont mentioned this in R65:8d6d9d2e1ce1: style: Make the menu fill the screen.
ardumont mentioned this in R65:ee5b8cdb224e: style: Align the navigator bar to the right.
ardumont mentioned this in R65:012168efe802: style: Fix in-page links covered by navbar.
ardumont mentioned this in R65:bd2a3c434eca: style: Add back to top link.
ardumont mentioned this in R65:b4c36306c72c: apidoc: Fix empty line.
ardumont mentioned this in R65:fca1bee22ad5: style: Fix in-page links covered by navbar.
ardumont mentioned this in R65:c29a1193dd62: style: Remove border on left and right for the fixed menu.
ardumont mentioned this in R65:f151bfaa47cf: style: Use red-ish border for apidoc table.
ardumont mentioned this in R65:c81e8888a2b3: apidoc: List endpoints in a responsive table.
ardumont mentioned this in R65:d3ea1d5213b9: apidoc: Fix rendering glitch with ~.
ardumont mentioned this in R65:152737fcf612: apidoc: Fix positioning glitch between fixed header and datatable.
ardumont mentioned this in R65:115e6a917d01: apidoc: Unify font color for upcoming/deprecated rows.
ardumont mentioned this in R65:e89686a2ddeb: apidoc: Add breadcrumb links.
ardumont mentioned this in R65:973c250b2f21: style: Remove duplicated a entry.
ardumont mentioned this in R65:7779471fc71a: apidoc: Rename page titles with a better description.
ardumont mentioned this in R65:cf36f86eb7a7: apidoc: Remove /browse from header menu.
ardumont mentioned this in R65:243cff6d3491: apidoc: Rename upper breadcrumb from Home to API.
ardumont mentioned this in R65:1559b56bb633: apidoc: Do not present upcoming endpoint documentation.
ardumont mentioned this in R65:7fbf38c5513a: apidoc: Link in header menu points to archive.
ardumont mentioned this in R65:532291c6505b: apidoc: Add archive label text to swh logo.
gitlab-migration changed the task status from Resolved to Migrated.Jan 8 2023, 9:56 PM
gitlab-migration claimed this task.
gitlab-migration added a subscriber: gitlab-migration.

This task has been migrated to GitLab.

About · Developer information · Legal