open-metadata / docs Goto Github PK

The tile component should look like

based on Sanket's updated layout

let's add more padding on the left to not be too close to the menu

Use the SVG Icons provided by Sanket for the left-side menu

Issue

Currently accordion hides the actual content that must be visible upfront

Potential approach

Find some UI / UX to show below details upfront on the page instead hidden behind accordion

to support glue from database and pipelines

• Links to external content should open a new tab -> do that manually in the markdown content by using <a href="http://example.com/" target="_blank">Hello, world!</a>
• Collapse on Usage has too much spacing between titles → css on H4 https://github.com/open-metadata/docs/blob/main/components/blocks/headers.js
• Hyperlinks should be of a different color instead of the underline https://github.com/open-metadata/docs/blob/main/components/utilities/headerLink.module.css
• caption in images is not centered. Make it a bit grayish to not confuse with the rest of the body

• Body justify instead of left align
• --- style for a breakline is too strong. It should be grayed out and thinner -> <hr>
• Left menu arrow color
• Left menu title color
• Left menu background and active colors
• Previous/next button
• InlineCallout style
• Icons from OM (thinner style)
• Click on the whitespace on the menu does not redirect -> gather more feedback on best use. Either click on arrow redirects or click on whitespace does not redirect.
• Code in a title looks weird (low priority)
• Quote > parsing (low priority)
• Right pannel overhaul we can do later

It looks like the instructions for setting up Azure SSO for Kubernetes may be out-of-date with release 0.12.0.

I have completed the instructions on the Azure SSO page. However, I've encountered a couple of potential issues on the Azure SSO for Kubernetes page:

1. The docs show that Airflow's configuration for Azure SSO resides under the following field:
   global.airflow.openmetadata.azure

However, the Helm chart's values.yaml file shows it under the following field:
global.airflow.openmetadata.authConfig.azure

2. It looks like the org.openmetadata.service.security.DefaultAuthorizer authorizer class has been replaced with the org.openmetadata.catalog.security.DefaultAuthorizer in 0.12.0? (If I try to use the authorizer shown in the docs, it throws a "class not found" error.)

3. If I use the org.openmetadata.catalog.security.DefaultAuthorizer authorizer class, I no longer get a "class not found" error. However, I do get a "java.lang.NullPointerException". (It's possible that this error is unrelated to the authorizer class, but I thought I'd include it just in case it has different requirements in the values.yaml file.)

Before I further troubleshoot the NullPointException issue, I'd like to confirm that the docs are up-to-date for 0.12.0. Could someone please take a look at the Azure SSO for Kubernetes page and update it to reflect what is required for 0.12.0? I'll be happy to test the changes. (My deepest apologies in advance if it is "user error", but there do seem to be some discrepancies. :)

Instead of using the + & - signs:

Let's use the same arrow

we have from the UI

• Can we add some horizontal padding to our content? It is looking quite congested.
• Top right icons i.e. Slack, Github and Swagger are inconsistent
• Hover on sidebar menu item isn't proper. The caret icon becomes lighter when we more cursor to right.
• We can also add some vertical padding to sidebar menu item.
• On 404 page, "Get started" dropdown isn't working properly.

we're hiding it for now

docs site crashes when opening any page section url ( {host} / {path} # {section})
example: https://docs.open-metadata.org/openmetadata/connectors/database/clickhouse#2-create-a-new-service

we can add Tip and Note

<Tip>

A tip

</Tip>

<Note>

A note

</Note>

Use different icons and OM colors for the style

We will control it in markdown via:

<details>
  <summary>Click to expand!</summary>

## Heading

1. A numbered
2. list
    * With some
    * Sub bullets

</details>

either make it bigger and bolder, showcase better the arrow or add a new page

Anchor Links like this in the doc

- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Data Profiler](#data-profiler)
- [Data Quality](#data-quality)
- [dbt Integration](#dbt-integration)

don't bring you to localhost:3000/v1.0.0/connectors/database/mariadb#requirements but redirect you to http://localhost:3000/v1.0.0#requirements in the new doc.

The top bar style should resemble the UI bar

The elements should be:

• left: OM logo + cloud button, similar to
  

• center: search bar

• right: theme toggle, Slack logo with link, Github logo with link

update the component

to point to our github discussions and slack #support channel

We need to update the tailwind config, as well as individual component CSS if needed, to use OM's fonts and color palettes

Apply something as the GE expectations docs https://greatexpectations.io/expectations

• Introduced at
• Status (beta, prod)
• supports lineage Y/N
• supports profiler Y/N
• ...

Use Algolia search for our search bar

Review where this data is being sent and if it makes sense for us to integrate it somewhere else.

If we need to do this later on, for now we could just disable the component

• Check 301 redirections from main pages of the old docs
• Update CNAME to point to docs.open-metadata.org
• Link google analytics with the right url

Update the icon with our style and update the link to open-metadata/OpenMetadata/issues with the proposal for the docs

Trying to scroll down the left menu, it does not show the latest elements until you scroll down the whole page.

You can check it here https://openmetadata-docs.netlify.app/

• Clicking anywhere on search suggestions should redirect to respective result. Currently it only redirects when clicked on heading

• Scrolling to the bottom on the content panel, the side navigation also scrolls

Currently we have this content/gdpr-banner.md file. We should review where it is being used and analyze how we want to handle cookies and for what

We should center the images and not show all the grey background

TODO

• Features page should link to further explanations of the topics inside OpenMetadata
• Separated section for OpenMetadata SDK
• Developers section should have community and setup guidelines
• Deployment and Upgrades
• OM & Prefect https://docs.open-metadata.org/overview/run-openmetadata-with-prefect
• Tutorial? https://docs.open-metadata.org/overview/tutorials
• Review Volumes info (/deployment/docker/volumes). Is it even needed?
• Moved airflow to deployment section for installation. The connector (and lineage backend) will be explained inside connectors
• Google and Okta security is missing. It is just a copy paste atm.
• Pipeline connectors are missing
• Update publish

Won't Migrate

• Connection Configuration Parameters https://docs.open-metadata.org/deploy/reference/connector-configuration
• metadata CLI for deployment
• The sections below are part of the Features page
  

We should show:

• categories on the top
• description that matches the result, if exists

https://publish--openmetadata-docs.netlify.app/metadata-ui/connectors/database/athena#6-schedule-the-ingestion-and-deploy