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

Add Outline to new documentation site #41

Closed
wants to merge 11 commits into from
Closed

Add Outline to new documentation site #41

wants to merge 11 commits into from

Conversation

Vebop
Copy link
Collaborator

@Vebop Vebop commented Sep 30, 2024

Adding documentation tree as discussed in slack.

@Vebop Vebop changed the title Tickets/dm 46556 Add Outline to new documentation site Sep 30, 2024
@Vebop Vebop marked this pull request as ready for review September 30, 2024 23:24
ConsDbClient in summit_utils
############################

Is this a repeat, or a different scope than the other page?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, I could see pages in all three of:

  • User Guide for querying using ConsDbClient
  • Contributor Guide for inserting using ConsDbClient
  • Developer Guide for how to write and test code in lsst-sitcom/summit_utils

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh that middle one is not a page, but it is a section in the Inserting page. I added the other sentences to the corresponding pages so it is more clear now.

Copy link
Contributor

@JeremyMcCormick JeremyMcCormick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You must rename your ticket branch to tickets/DM-46556. The capitalization of "DM" is important for our documentation system and other tools to work properly.

Please close this PR and make another with the new branch name. (git branch tickets/DM-46556 from your current branch should work fine).

@Vebop Vebop closed this Oct 1, 2024
@Vebop Vebop deleted the tickets/dm-46556 branch October 1, 2024 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants