Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
documentation
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
OCF
documentation
Commits
babffcc1
Commit
babffcc1
authored
6 months ago
by
Julien Satti
Browse files
Options
Downloads
Patches
Plain Diff
Tweak documenting process
parent
0c6b6899
No related branches found
No related tags found
No related merge requests found
Pipeline
#10987
passed
6 months ago
Stage: deploy
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc/contribute/documenting.md
+13
-12
13 additions, 12 deletions
doc/contribute/documenting.md
with
13 additions
and
12 deletions
doc/contribute/documenting.md
+
13
−
12
View file @
babffcc1
...
...
@@ -16,16 +16,17 @@ Documenting OpenCAPIF is limited to active contributors. So, if you:
### How it works?
There are 2 ways to upgrade documentation published on [OCF Documentation]:
*
Push any change on
**develop**
branch will force update of
**develop**
version on the [OCF Documentation] website;
*
Create a tag, this will create a version with tag name on the [OCF Documentation] website.
There are 2 ways to upgrade documentation published on the [OCF Documentation] website:
*
Push any change on
**develop**
branch will force update of the
**develop**
version on the [OCF Documentation] website;
*
Create a tag, this will create a version with the tag name on the [OCF Documentation] website.
### Branches
This documentation repository has 2 protected branches:
*
**main**
: this branch will store the information stable;
*
**develop**
: any change uploaded on this branch will upgrade
**develop**
version of the documentation published on the [OCF Documentation] website.
*
**main**
: this branch will store the information stable;
*
**develop**
: any change uploaded on this branch will upgrade
**develop**
version of the documentation published on the [OCF Documentation] website.
### Structure
...
...
@@ -46,11 +47,11 @@ nav:
```
As you can see here, we have at the time of writing this page, 5 main sections:
*
Overview: here we placed high-level information like version changelog, some initial scripts, ...
*
Getting Started: this section contains a simple way to start working with the project;
*
Testing: detailed information of
**how to test**
OpenCAPIF, and test plan developed to ensure the code has all implemented functionality checked;
*
Contribute: details about how to contribute code and docs;
*
FAQ.
*
Overview: here we placed high-level information like version changelog, some initial scripts, ...
*
Getting Started: this section contains a simple way to start working with the project;
*
Testing: detailed information of
**how to test**
OpenCAPIF, and test plan developed to ensure the code has all implemented functionality checked;
*
Contribute: details about how to contribute code and docs;
*
FAQ.
### Main Page
...
...
@@ -103,8 +104,8 @@ To update the documentation during development, follow those steps:
2.
Create an issue on
[
GitLab
](
https://labs.etsi.org/rep/ocf/documentation/-/issues
)
;
3.
Create a new branch with source from
**develop**
;
4.
Update documentation:
1.
*
**Remember to update index.md with new functionalities for the latest version**
*
;
2.
N
ew test plan is defined
?
**
U
pdate test plan documentation**
1.
**Remember to update index.md with new functionalities for the latest version**
;
2.
If a n
ew test plan is defined
, remember to
**
u
pdate
the
test plan documentation**
5.
Check if errors are being produced by
``mkdocs``
[
locally
](
#getting-started
)
;
6.
Push changes to branch;
7.
Create a merge/pull request;
...
...
This diff is collapsed.
Click to expand it.
Julien Satti
@sattij
mentioned in commit
30b107f0
·
6 months ago
mentioned in commit
30b107f0
mentioned in commit 30b107f088ff65b3967f2d9a16a49bb9980aaacb
Toggle commit list
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment