open-metadata / docs-v1 Goto Github PK
View Code? Open in Web Editor NEWOpenMetadata docs page source code
Home Page: https://docsv1.netlify.app
OpenMetadata docs page source code
Home Page: https://docsv1.netlify.app
Is it me, or is this a typo? "data a management"?
Found on the landing page: https://docs.open-metadata.org
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
v1.0.0
Visit the API documentation and explore the rich set of OpenMetadata APIs
. API link not working.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
Add debouncing to the search functionality to reduce the number of API calls
Use rapiDocs to show the APIS info on swagger page.
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:
yarn dev
)linkcheck -e [domain]
linkcheck -e [domain] >linkcheck.log
)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.
Let's track here any improvements for the v1 docs
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
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" /%}
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.
Refactor the how-to guide pages so that the left side navigation bar should only show the selected category items
Code Preview
component is present in the page content. the collapse behavior should be only for the smaller screens.Implement blog posts auto-updation using HashNode APIs.
We have 2 pages that could use improvement
Connector list page https://docs.open-metadata.org/v1.2.x/connectors
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
cc @harshach
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.