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

Remove some blog references from docs and docs/tools #1970

Merged
merged 1 commit into from
Oct 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,11 @@ feat/4922-add-avro-support
* **fix** - a change that fixes a bug (ticket required)
* **exp** - an experiment where we are testing a new idea or want to demonstrate something to the team, might turn into a `feat` later (ticket encouraged)
* **test** - anything related to the tests (ticket encouraged)
* **blogs** - a new entry to our blog (ticket optional)
* **docs** - a change to our docs (ticket optional)

#### Ticket Numbers

We encourage you to attach your branches to a ticket, if none exists, create one and explain what you are doing. For `feat` and `fix` branches, tickets are mandatory, for `exp` and `test` branches encouraged and for `blogs` and `docs` branches optional.
We encourage you to attach your branches to a ticket, if none exists, create one and explain what you are doing. For `feat` and `fix` branches, tickets are mandatory, for `exp` and `test` branches encouraged and for `docs` branches optional.

### Submitting a hotfix
We'll fix critical bugs and release `dlt` out of the schedule. Follow the regular procedure, but make your PR against **master** branch. Please ping us on Slack if you do it.
Expand Down
7 changes: 0 additions & 7 deletions docs/tools/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@


DOCS_DIR = "../website/docs"
BLOG_DIR = "../website/blog"


def collect_markdown_files(verbose: bool) -> List[str]:
Expand All @@ -25,12 +24,6 @@ def collect_markdown_files(verbose: bool) -> List[str]:
if verbose:
fmt.echo(f"Discovered {filepath}")

# collect blog pages
for filepath in glob.glob(f"{BLOG_DIR}/**/*.md", recursive=True):
markdown_files.append(filepath)
if verbose:
fmt.echo(f"Discovered {filepath}")

if len(markdown_files) < 50: # sanity check
fmt.error("Found too few files. Something went wrong.")
exit(1)
Expand Down
6 changes: 2 additions & 4 deletions docs/website/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The website is a Node.js application.

The documentation is generated using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
The documentation is generated using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
Docusaurus consumes content from the `./docs` folder (at `./docs/website/docs` in this repo). The content includes:

- markdown files
Expand All @@ -11,8 +11,6 @@ Docusaurus consumes content from the `./docs` folder (at `./docs/website/docs` i

On the production website the documentation appears at https://dlthub.com/docs and the default documentation page is https://dlthub.com/docs/intro.

Docusauraus also consumes blog posts (from `./blog`) and they appear at https://dlthub.com/docs/blog.

## Installation

With `website` as your working directory:
Expand Down Expand Up @@ -83,7 +81,7 @@ This will execute the script at tools/update_versions.js. This tool will do the
* It will create a future version called "devel" from the current commit of this repo.
* It will set up docusaurus to display all of these versions correctly.

You can clear these versions with
You can clear these versions with

```
npm run clear-versions
Expand Down
Loading