open-metadata/docs-v1

OpenMetadata docs page source code

docs-v1's Issues

Typo on docs landing page

Is it me, or is this a typo? "data a management"?

Found on the landing page: https://docs.open-metadata.org

docs-v1/constants/homePage.constants.tsx

Line 8 in 46c9456

"Unlock the value of data a management solution that includes data discovery, governance, data quality, observability, and people collaboration.",

docs: improve the connectors list on homepage

Improve the component to show connectors list to divide it based on categories

yaml copy is in incorrect format.

This is how the yaml looks in docs page.

but after copy and pasting it this is how it becomes

which leads to user errors while ingesting metadata, hence there is a need to fix this,

Icon support

in the old docs we could have pages like this https://raw.githubusercontent.com/open-metadata/OpenMetadata/main/openmetadata-docs/content/deployment/index.md where we say:

<InlineCallout
    color="violet-70"
    icon="add_moderator"
    bold="Enable Security"
    href="/deployment/security"
  >
    Enable Security for your OpenMetadata deployment
  </InlineCallout>

And we could add this icon value with some icons from sources like material icons, or similar. I think we are now passing the icons as SVGs directly. Not sure if we can point to external icons to make it easier to try out and change

Searches not working properly

Searches in the docs need to be fixed.

For example, the "Secrets Manager" page which has the name in the title, and the words "Secrets Manager" are repeated in a few places:

However, the results displayed when I search for it are not related:

Links related bugs

• Change the default version to v1.0.0
• Clicking on the copy link icon for headings does not copy full URL with http
• Hash links don't render properly
• At this path http://localhost:3000/v0.13.2/quick-start/sandbox Visit the API documentation and explore the rich set of OpenMetadata APIs. API link not working.

Include a way to see / navigate to more blogs than just 3

Docs Homepage Provides a section to view Blogs but it only limits to 3. Users should be able to view / navigate more blogs available in OpenMetadata.

Fix the redirection issue for documentation links

Improve redirection for links
example
visiting
https://docs.open-metadata.org/v1.0.0/connectors/ingestion/lineage
redirects to
https://docs.open-metadata.org/v1.1.x/v1.0.0/connectors/ingestion/lineage

Pagefind implementation for search

• Implement pagefind for search functionality.

Connectors list placeholder icon

• Show placeholder icon while loading and if the icon is not present in the connecters list on the homepage

Introduce debouncing for search functionality

Add debouncing to the search functionality to reduce the number of API calls

docs.open-metadata.org mobile layout doens't work

For Roadmap page

• In tile tag need to handle

<li>Stabilization and Improvements to Schemas and APIs</li>
   <li>Backward compatability of the APIs </li>

this type of content.

Replace ReDoc with rapiDocs

Use rapiDocs to show the APIS info on swagger page.

Implementing the broken-link check workflow for the documentation

We need to add the broken link check for the documentation. We can use linkcheck for this.
Here is a reference on how to add it as github actions.

For running the checks:

1. Start the server (yarn dev)
2. Trigger checks by running linkcheck -e [domain]
3. We can save the logs for the same (linkcheck -e [domain] >linkcheck.log)

Version functionality improvements for usability of old links

The existing older documentation link should redirect to the latest version page. For Example, if we visit this link https://docs.open-metadata.org/v1.1.x/how-to-guides/quick-start-guide-for-admins/how-to-ingest-metadata/delete-service-connection it should redirect to the latest version.

Docs V1 Feedback

Let's track here any improvements for the v1 docs

Provide ability to include hash links in the menu.md

We are thinking of adding the information about all the releases to the documentation. The links of all the releases need to be provided in the side nav bar.
Currently, the hash URLs are not picked up from the menu.md file like normal URLs.
Provide the ability to add the menu items for hash links as well

Remove 0.13.1 and 0.13.2 from versions list on docs.open-metadata.org

Support search for each version

• Prepare index creation and settings in Algolia @pmbrull
• Update UI @aniketkatkar97

Partials improvements

• partial files should support full path import, not just file name. This is required to work with multiple versions.
• We should also support passing variables to the markdoc components (note the caveats https://markdoc.dev/docs/variables#caveats)

Examples for variables we need:

{% tile
    title="Ingest with the CLI"
    description="Run a one-time ingestion using the metadata CLI"
    link="/connectors/database/$connector/cli"
  / %}

{% image
src="/images/v1.1.0/connectors/$connectorPath/select-service.png"
alt="Select Service"
caption="Select your service from the list" /%}

Implement Dynamic Generation of Titles, Descriptions, and Images for Documentation links Preview

The objective of this issue is to enhance the preview experience when sharing documentation links on social media platforms like Twitter, LinkedIn, and messaging platforms like Slack.

Currently, when we share documentation links, the preview often lacks context and visual appeal, leading to reduced engagement and clarity. By implementing dynamic generation of titles, descriptions, and images, we aim to provide users with more informative and visually compelling previews.

UI: Release ordering + listing

• Releases should be ordered based on the recent release first
• Releases should have stable / beta tags

reference image:

docs: refactor how to guides left navigation bar

Refactor the how-to guide pages so that the left side navigation bar should only show the selected category items

Side navigation panel improvements

• The side panel collapses in case the Code Preview component is present in the page content. the collapse behavior should be only for the smaller screens.
• Make the collapse and expand animation smoother.

In Airflow pipeline Lineage backend and operator page is not working.

It's giving error when we open that page.

Unhandled Runtime Error
NotFoundError: Failed to execute 'insertBefore' on 'Node': The node before which the new node is to be inserted is not a child of this node.

Implement automation for the blog posts

Implement blog posts auto-updation using HashNode APIs.

Custom component for connector header and list

We have 2 pages that could use improvement

1. Connector list page https://docs.open-metadata.org/v1.2.x/connectors
   

2. Each connector landing
   

We should figure out how to organize the information at the top and add who developed the component (Collate vs. Community) to also align expectations.

Instead of a table, we could wrap this into something a bit more polished. Then, a smaller version could be used for the connector list.

A good example is this https://greatexpectations.io/expectations

Warning field not available for new docs

Warning Field used in docs, currently no way to show it.

Same for Tip Field.

Docs improvements

cc @harshach

• We should use a subtle color similar to GitHub for quoted strings. Currently, it is too bright and in your face.

• The comment icon is not aligned with the text

• Icons for thumbs up and down are too big and don't align with the text

• Heading sizes are too big and should be reduced
• Expand a topic on the left panel and click it. Now the other items can't be clicked. In this example, I can't click SingleStore or any other topic on the left panel.