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

docs(i): Import docs from doc repo #2596

Merged

Conversation

AndrewSisley
Copy link
Contributor

Relevant issue(s)

Resolves #2595

Description

Imports the docs from doc repo (https://github.com/sourcenetwork/docs.source.network/tree/master/docs/defradb).

The first commit imports the linked directory as-is - nothing has changed.

The second commit adds a very simple readme to highlight that they are used for the docs website - it can be expanded over time.

The commits after that import the 0.10.0 and 0.11.0 change logs into the directory, and tweak them to match the ones already in the repo.

Note: The other change logs (0.9 and earlier) include the below snip-it at the top of the change log files with different numerical values, I don't understand it and have not added it to 0.10.0 and 0.11.0 - I'm happy to do so in this PR if someone tells me what values it should have :) Otherwise it can be done later.

@AndrewSisley AndrewSisley added the documentation Improvements or additions to documentation label May 6, 2024
@AndrewSisley AndrewSisley added this to the DefraDB v0.12 milestone May 6, 2024
@AndrewSisley AndrewSisley requested a review from a team May 6, 2024 21:21
@AndrewSisley AndrewSisley self-assigned this May 6, 2024
Copy link
Member

@nasdf nasdf left a comment

Choose a reason for hiding this comment

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

LGTM. We'll need to update the CLI doc generation so we don't have duplicates. We should also consider adding OpenAPI docs using the genopenapi command.

Copy link
Collaborator

@fredcarle fredcarle left a comment

Choose a reason for hiding this comment

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

LGTM. Please add the metadata as described bellow before merge.

Note: The other change logs (0.9 and earlier) include the below snip-it at the top of the change log files with different numerical values, I don't understand it and have not added it to 0.10.0 and 0.11.0 - I'm happy to do so in this PR if someone tells me what values it should have :) Otherwise it can be done later.

Since the software orders sidebar items alphanumerically by default, the sidebar position metadata at the top of the file helps enforce a given order. The higher the number, the higher in the list it will be listed. Without it, the list would be:

  • v0.10.0
  • v0.11.0
  • v0.2.0
  • v0.2.1
  • ...
    What we actually want is:
  • v0.11.0
  • v0.10.0
  • v0.9.0
  • ...
    So the metadata needs to be added to v0.10.0 and v0.11.0 with values
    sidebar_position: 100 and sidebar_position: 110 respectively.

@AndrewSisley
Copy link
Contributor Author

AndrewSisley commented May 7, 2024

So the metadata needs to be added to v0.10.0 and v0.11.0 with values
sidebar_position: 100 and sidebar_position: 110 respectively.

Nice, thanks Fred :)

  • Add sidebar position

@AndrewSisley AndrewSisley merged commit 81183f5 into sourcenetwork:develop May 7, 2024
27 of 28 checks passed
@AndrewSisley AndrewSisley deleted the 2595-docs-from-doc-repo branch May 7, 2024 14:34
shahzadlone pushed a commit that referenced this pull request May 14, 2024
## Relevant issue(s)

Resolves #2595

## Description

Imports the docs from doc repo
(https://github.com/sourcenetwork/docs.source.network/tree/master/docs/defradb) and adds the 0.10.0 and 0.11.0 change logs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move doc repo docs into defra repo
3 participants