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.

Sign up for GitHub

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/fix docs deployment 3 devel #1827

Merged
merged 2 commits into from
Sep 16, 2024
Merged

Docs/fix docs deployment 3 devel #1827

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f1652b
clear more caches
sh-rp Sep 16, 2024
33194e3
Revert "remove doccard list"
sh-rp Sep 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/website/docs/dlt-ecosystem/verified-sources/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ Planning to use `dlt` in production and need a source that isn't listed? We're h

### Core sources

<DocCardList items={useCurrentSidebarCategory().items.filter(
item => item.label === '30+ SQL Databases' || item.label === 'REST APIs' || item.label === 'Filesystem & cloud storage'
)} />

### Verified sources

Choose from our collection of verified sources, developed and maintained by the `dlt` team and community. Each source is rigorously tested against a real API and provided as Python code for easy customization.
Expand All @@ -19,6 +23,10 @@ Choose from our collection of verified sources, developed and maintained by the
If you couldn't find a source implementation, you can easily create your own, check out the [resource page](../../general-usage/resource) to learn how!
:::

<DocCardList items={useCurrentSidebarCategory().items.filter(
item => item.label !== '30+ SQL Databases' && item.label !== 'REST API generic source'&& item.label !== 'Filesystem & buckets'
)} />

### What's the difference between core and verified sources?

The main difference between the [core sources](#core-sources) and [verified sources](#verified-sources) lies in their structure.
Expand Down
2 changes: 1 addition & 1 deletion docs/website/tools/preprocess_docs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ if (process.argv.includes("--watch")) {
if (Date.now() - lastUpdate < 500) {
return;
}
fs.rmdirSync(MD_TARGET_DIR, {force: true, recursive: true})
fs.rmSync(MD_TARGET_DIR, {force: true, recursive: true})
console.log('%s changed...', name);
syncExamples();
preprocess_docs();
Expand Down
8 changes: 6 additions & 2 deletions docs/website/tools/update_versions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ const semver = require('semver')
// const
const REPO_DIR = ".dlt-repo"
const REPO_DOCS_DIR = REPO_DIR + "/docs/website"
const REPO_PREPROCESSED_FILES_DIR = REPO_DOCS_DIR + "/docs_processed"
const REPO_URL = "https://github.com/dlt-hub/dlt.git"
const VERSIONED_DOCS_FOLDER = "versioned_docs"
const VERSIONED_SIDEBARS_FOLDER = "versioned_sidebars"
Expand All @@ -19,6 +20,7 @@ fs.rmSync(REPO_DIR, { recursive: true, force: true })

// checkout fresh
console.log("Checking out dlt repo")
fs.rmSync(REPO_DIR, {force: true, recursive: true})
proc.execSync(`git clone ${REPO_URL} ${REPO_DIR}`)

// find tags
Expand Down Expand Up @@ -91,6 +93,9 @@ for (const version of selectedVersions) {
// process.exit(1)
// }

// clear preprocessed docs in subrepo
fs.rmSync(REPO_PREPROCESSED_FILES_DIR, { force: true, recursive: true})

// build doc version, we also run preprocessing and markdown gen for each doc version
console.log(`Building docs...`)
proc.execSync(`cd ${REPO_DOCS_DIR} && npm run preprocess-docs && PYTHONPATH=. pydoc-markdown`)
Expand All @@ -100,8 +105,7 @@ for (const version of selectedVersions) {

console.log(`Moving snapshot`)
fs.cpSync(REPO_DOCS_DIR+"/"+VERSIONED_DOCS_FOLDER, VERSIONED_DOCS_FOLDER, {recursive: true})
fs.cpSync(REPO_DOCS_DIR+"/"+VERSIONED_SIDEBARS_FOLDER, VERSIONED_SIDEBARS_FOLDER, {recursive: true})

fs.cpSync(REPO_DOCS_DIR+"/"+VERSIONED_SIDEBARS_FOLDER, VERSIONED_SIDEBARS_FOLDER, {recursive: true})
}

fs.cpSync(REPO_DOCS_DIR+"/versions.json", "versions.json")
Loading