Skip to content

Commit 4f9cc9f

Browse files
committed
docs: add metadata to all non-autogenerated files
1 parent fe6a6b6 commit 4f9cc9f

File tree

168 files changed

+1030
-25
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

168 files changed

+1030
-25
lines changed

docs/contributor/howto/compile-and-run-juju-agents-on-different-architectures.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
myst:
3+
html_meta:
4+
description: "Build and deploy Juju agents across multiple architectures using local simplestreams repositories for cross-platform testing."
5+
---
6+
17
(compile-and-run-juju-agents-on-different-architectures)=
28
# Compile and run Juju agents on different architectures
39

docs/contributor/howto/create-a-unit-test-suite.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
myst:
3+
html_meta:
4+
description: "Build unit test suites for Juju with proper setup and teardown logic using BaseSuite and gocheck test patterns."
5+
---
6+
17
(create-a-unit-test-suite)=
28
# Create a unit test suite
39
> See also: {ref}`unit-test-suite`

docs/contributor/howto/create-new-mongo-db-collection.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
myst:
3+
html_meta:
4+
description: "Add new MongoDB collections to Juju's state package, define entity structures, and implement proper document validation patterns."
5+
---
6+
17
# Create a new MongoDB collection
28
Sometimes developers need to store some new entities in Juju DB. This document provides key points for adding a new
39
collection to MongoDB.

docs/contributor/howto/debug-a-dqlite-core-dump-issue.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
myst:
3+
html_meta:
4+
description: "Diagnose and debug Dqlite core dump issues in Juju 3.2+, including validation checks and backtrace collection for issue resolution."
5+
---
6+
17
(debug-a-dqlite-core-dump-issue)=
28
# Debug a Dqlite core dump issue
39

docs/contributor/howto/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
myst:
3+
html_meta:
4+
description: "Explore step-by-step how-to guides for Juju developers covering testing, debugging, MongoDB management, and cross-architecture development."
5+
---
6+
17
(contributor-how-to-guides)=
28
# How-to guides
39

docs/contributor/howto/manage-mongodb.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
myst:
3+
html_meta:
4+
description: "Configure MongoDB profiling, optimize query performance, and manage database operations for Juju development and debugging."
5+
---
6+
17
(manage-mongodb)=
28
# Manage MongoDB
39

docs/contributor/howto/merge-forward.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
myst:
3+
html_meta:
4+
description: "Merge bug fixes and patches forward across Juju version branches, handling conflicts and maintaining version compatibility."
5+
---
6+
17
# Merge forward
28

39
Juju generally has multiple versions in concurrent development, and we keep a separate Git branch for each. Often, a bug

docs/contributor/howto/write-a-unit-test.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
myst:
3+
html_meta:
4+
description: "Learn how to write unit tests for Juju using gocheck, including creating test files, suites, and implementing effective test patterns."
5+
---
6+
17
(write-a-unit-test)=
28
# Write a unit test
39
> See also: {ref}`unit-testing`

docs/contributor/howto/write-an-integration-test.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
myst:
3+
html_meta:
4+
description: "Create integration tests for Juju using bash test suites, including bootstrapping, test execution, and teardown procedures."
5+
---
6+
17
(write-an-integration-test)=
28
# Write an integration test
39
> See also: {ref}`integration-testing`

docs/contributor/howto/write-tests.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
myst:
3+
html_meta:
4+
description: "Master writing tests for Juju using go test and gocheck, including unit and integration testing best practices for contributors."
5+
---
6+
17
(write-tests)=
28
# Write tests
39

0 commit comments

Comments
 (0)