Skip to content

Commit 0076dea

Browse files
Merge pull request #293 from HarperDB/update-contributing
update contributing.md to reflect new site organization
2 parents ba92a38 + cca5e71 commit 0076dea

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ npm run format
3434

3535
This site is powered by Docusaurus and leverages the file-system based versioning capabilities of the framework.
3636

37-
All published content is available within the `site/` directory. Specific pages are organized into subdirectories based on their version.
37+
There are two directories where actual documentation content lives.
3838

39-
The root of the site is mapped to the `site/versioned_docs/version-4.6` directory.
39+
The first, `docs/` contains the "latest" or "next" version of the documentation. We do not publish or render this directory, and the content here is meant to represent on-going development.
4040

41-
So for example the page https://docs.harperdb.io/docs/getting-started/first-harper-app maps to the file `site/versioned_docs/version-4.6/getting-started/first-harper-app.md`. And then the previous 4.5 version of it can be found at `site/versioned_docs/version-4.5/getting-started/first-harper-app.md`. Not all files exist across all versions, and generally you only need to update content across versions 4.6 and 4.5 unless you're specifically targeting an older version.
41+
The second, `versioned_docs` contains all of the specific Harper version documentation organized by minor version. The latest version within this directory maps to the default path on the site. For example, if the latest version is `versioned_docs/version-4.6/` then the page https://docs.harperdb.io/docs/getting-started/first-harper-app maps to the file `site/versioned_docs/version-4.6/getting-started/first-harper-app.md`. And for the previous 4.5 version the page http://localhost:3000/docs/4.5/getting-started/first-harper-app can be found at `site/versioned_docs/version-4.5/getting-started/first-harper-app.md`.
4242

43-
The root `docs/` directory contains doc files intended for the next version release so depending on your intended changes you may want to copy them to the respective files within that directory too.
43+
Depending on the specific change, you may need to make updates to similar files across multiple version directories as well as the root `docs/`.
4444

4545
The site organization is ever evolving so make sure to revisit this file over time to stay up to date with the latest structure.

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)