From de99e1392b8d4264e7d7c4e64b57461712e9e44b Mon Sep 17 00:00:00 2001
From: Royer Yangali <royer.yangali@etsi.org>
Date: Mon, 26 Aug 2024 14:21:08 +0200
Subject: [PATCH] UPDATE: updating TFS README
---
README.md | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 573def1..9ad6192 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,12 @@
# 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
--
GitLab