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
TFS
documentation
Commits
de99e139
Commit
de99e139
authored
8 months ago
by
yangalicace1
Browse files
Options
Downloads
Patches
Plain Diff
UPDATE: updating TFS README
parent
31e94329
No related branches found
No related tags found
No related merge requests found
Pipeline
#7971
failed
8 months ago
Stage: deploy
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+11
-11
11 additions, 11 deletions
README.md
with
11 additions
and
11 deletions
README.md
+
11
−
11
View file @
de99e139
# Documentation
This respository contains the documentation of
OpenCAPIF
.
This respository contains the documentation of
TeraflowSDN
.
## 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 [
OCF
Documentation].
*
Create a tag, this will create a version with tag name on [
OCF
Documentation].
There are 2 ways to upgrade documentation published on [
TFS
Documentation]:
*
Push any change on
**develop**
branch will force update of
**develop**
version on [
TFS
Documentation].
*
Create a tag, this will create a version with tag name on [
TFS
Documentation].
## Repository Branches
...
...
@@ -15,13 +15,13 @@ 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 on documentation published on [
OCF
Documentation]
*
Any change uploaded on this branch will upgrade
**develop**
version on documentation published on [
TFS
Documentation]
## What should be the flow to add documentation during development
The steps to upgrade documentation are:
1.
Perform the development of functionality on
capif
code respository.
2.
Create an issue on
[
Documentation Gitlab
](
https://labs.etsi.org/rep/
ocf
/documentation/-/issues
)
1.
Perform the development of functionality on
tfs
code respository.
2.
Create an issue on
[
Documentation Gitlab
](
https://labs.etsi.org/rep/
tfs
/documentation/-/issues
)
3.
Create new branch with source from
**develop**
.
4.
Update documentation:
1.
***Remember to update index.md with new functionalities for latest version***
...
...
@@ -33,7 +33,7 @@ The steps to upgrade documentation are:
## Release new version of documentation
When
**
OpenCAPIF
**
code repository is ready to share a new release we need to follow next steps by a
**TSC Member**
:
When
**
TeraflowSDN
**
code repository is ready to share a new release we need to follow next steps by a
**TSC Member**
:
1.
Create a new branch with released version, and merge it to
**develop**
.
2.
Create a Merge request from
**develop**
to
**main**
.
3.
When develop is merged to
**main**
, then we need to
**create a tag with released version.**
...
...
@@ -84,7 +84,7 @@ As you can see we have 4 main sections:
*
Getting Started:
*
This section must contain a simple way to start working with project.
*
Testing:
*
Detailed information of
**how to test**
OpenCAPIF
, and test plan developed to ensure the code has all implemented functionallity checked.
*
Detailed information of
**how to test**
TeraflowSDN
, and test plan developed to ensure the code has all implemented functionallity checked.
*
FAQ
## Main page
...
...
@@ -94,5 +94,5 @@ The page shown on first view is at **doc/index.md**
That page should be updated with latest changes on CAPIF, also including the version.
[
OCF Web
]:
https://ocf.etsi.org/
"OCF Web"
[
OCF Documentation
]:
https://ocf.etsi.org/documentation/
"OCF Documentation"
\ No newline at end of file
[
TFS Web
]:
https://tfs.etsi.org/
"TFS Web"
[
TFS Documentation
]:
https://tfs.etsi.org/documentation/
"TFS Documentation"
\ No newline at end of file
This diff is collapsed.
Click to expand it.
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