Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit this page + ToC design #6384

Merged
merged 42 commits into from
Jan 27, 2020
Merged

Edit this page + ToC design #6384

merged 42 commits into from
Jan 27, 2020

Conversation

zbayoff
Copy link
Contributor

@zbayoff zbayoff commented Jan 13, 2020

(Reopened from #5655)

  1. Adds Edit button in TOC which will link to the source md file in github, if it exists. If there is no md file, as would be the case for integrations, the Edit button links to open a new issue in Github.
  2. Updates the Mobile and Desktop TOC design. The TOC should now always be visible on desktop (if not disabled), and will be toggleable on mobile.
  3. The .mainContent-wrapper column is reduced from the current 9 columns to 7 columns for better readability. The 12 column layout is now 3 (sidenav) - 7 (main Content) - 2 (TOC). There may be a couple layout issues regarding tabs fitting into the smaller column width.

https://trello.com/c/XbTcdAlX/3367-add-dependencies-in-all-public-documentation-page

https://docs-staging.datadoghq.com/zach/editPage/

@zbayoff zbayoff requested a review from a team as a code owner January 13, 2020 16:35
@zbayoff
Copy link
Contributor Author

zbayoff commented Jan 13, 2020

#5655 (comment)

@l0k0ms l0k0ms added Architecture Everything related to the Doc backend WORK IN PROGRESS No review needed, it's a wip ;) labels Jan 14, 2020
@l0k0ms l0k0ms changed the title Zach/edit page Edit this page + ToC design Jan 15, 2020
@l0k0ms l0k0ms added the Do Not Merge Just do not merge this PR :) label Jan 17, 2020
@ruthnaebeck
Copy link
Contributor

It should be possible to disable the TOC and have pages stretch for the main integration page and landing pages (example).

For the integrations located in dogweb we should direct people to https://github.com/DataDog/documentation/issues/new?template=issue.md instead of https://github.com/DataDog/documentation/issues/new/choose. Also, can we check if there's a way to populate the referring URL into the GitHub text box?

Is there a way to handle pages that get combined (example)?

@ruthnaebeck
Copy link
Contributor

LGTM 🙂

@l0k0ms l0k0ms removed Do Not Merge Just do not merge this PR :) WORK IN PROGRESS No review needed, it's a wip ;) labels Jan 22, 2020
@cswatt cswatt merged commit 8ffee12 into master Jan 27, 2020
@cswatt cswatt deleted the zach/editPage branch January 27, 2020 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants