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: add data models as data source type in 360 docs and update 4.x docs #4645

Merged
merged 8 commits into from
Jun 27, 2024

Conversation

haakonflatval-cognite
Copy link
Contributor

@haakonflatval-cognite haakonflatval-cognite commented Jun 27, 2024

Type of change

Docs

Jira ticket 📘

https://cognitedata.atlassian.net/browse/

Description 📝

Ref. #4615

The large amount of changes is due to changes in how docusaurus 3.x structures the API-reference (or is it typedoc 🤔), which is first now applied to the 4.x docs.

How has this been tested? 🔍

Test instructions ℹ️

Checklist ☑️

  • I am proud of this feature.
  • I have performed a self-review of my own code.
  • I have added PR type (Feat, Bug, Chore, Test, Docs, Style, Refactor) to the PR title.
  • I have manually tested this for different scenarios (different models, formats, devices, browsers).
  • I have commented my code in hard-to-understand areas.
  • I have made corresponding changes to the public documentation.
  • I have added unit and visuals tests to prove that my feature works to the best of my ability.
  • I have refactored the code for readability to the best of my ability.
  • I have checked that my changes do not introduce regressions in the public documentation.
  • I have outlined any known defects / lacking capabilities in the contents of this PR.
  • I have listed any remaining work that should follow this PR in the description or jira/miro/etc.
  • I have added TSDoc to any public facing changes.
  • I have added "developer documentation" in any package README.md that is related / applicable to this PR.
  • I have noted down and am currently tracking any technical debt introduced in this PR.
  • I have thoroughly thought about the architecture of this implementation.
  • I have asked peers to test this feature.

@haakonflatval-cognite haakonflatval-cognite requested a review from a team as a code owner June 27, 2024 13:55
@haakonflatval-cognite haakonflatval-cognite changed the title docs: add data models as data source type in docs docs: add data models as data source type in docs and update 4.x docs Jun 27, 2024
@haakonflatval-cognite haakonflatval-cognite changed the title docs: add data models as data source type in docs and update 4.x docs docs: add data models as data source type in 360 docs and update 4.x docs Jun 27, 2024
Copy link
Contributor

@christjt christjt left a comment

Choose a reason for hiding this comment

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

LGTM!

@haakonflatval-cognite haakonflatval-cognite added the preview-docs Deploy preview documentation for a PR label Jun 27, 2024
@haakonflatval-cognite haakonflatval-cognite enabled auto-merge (squash) June 27, 2024 14:30
Copy link

📙 Documentation preview is available from
https://cognitedata.github.io/reveal-docs-preview/4645/docs/next/.

@haakonflatval-cognite haakonflatval-cognite merged commit fdf7388 into master Jun 27, 2024
23 checks passed
@haakonflatval-cognite haakonflatval-cognite deleted the hflatval/datamodels-360-docs branch June 27, 2024 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
preview-docs Deploy preview documentation for a PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants