Repository navigation
docs: apply the 5G-MAG README format - #33
Open
jordijoangimenez wants to merge 4 commits into
Open
jordijoangimenez wants to merge 4 commits into
jordijoangimenez wants to merge 4 commits into
Conversation
Problem The root README did not follow the common 5G-MAG README layout (banner, status/version/licence badges, At a glance, template sections), and some of its prose no longer matched the code. [code-derived] Basis No clause governs this; documentation layout from the 5G-MAG repository template (repo-starter, templates/README.md). Raised by Review by the repository owner. Change README.md restructured into the template sections with a banner (.github/banner.svg), badges, a link row and an At a glance table. Prose rewritten and corrected against the code at cef77bc. Every code block is byte-identical to the previous README; no command was added, removed or changed. Corrections are listed in the pull request. Verification T0: checked by a script comparing the old and new README: all 8 code blocks and code-bearing table rows identical, none added or dropped. Nothing built or run. Not in this change Sub-folder READMEs and any code.
Problem README.md, Running, says to configure the NRF in /usr/local/etc/open5gs/dcaf.conf. The build generates dcaf.yaml from dcaf.yaml.in (src/data-collection-af/meson.build:75-77, 92-94), installs it into open5gs_sysconfdir, and compiles open5gs-dcafd with DEFAULT_CONFIG_FILENAME "<open5gs_sysconfdir>/dcaf.yaml" (src/data-collection-af/meson.build:83). No dcaf.conf is installed or read. [code-derived] Basis No clause governs this; code-derived from the lines above. open5gs_sysconfdir is join_paths(sysconfdir, 'open5gs') in the open5gs subproject (5G-MAG/open5gs bbc-patches, configs/open5gs/meson.build:18), so with the default prefix the file is /usr/local/etc/open5gs/dcaf.yaml. The `nrf` section the sentence refers to is at dcaf.yaml.in:229. Raised by Review by the repository owner. Change README.md: dcaf.conf -> dcaf.yaml in the Running section. Verification T0: compared with the meson files at this commit and the open5gs subproject revision the wrap pins (bbc-patches). Nothing built or installed. Not in this change Any build file.
Problem The open pull request #32 (feature/integration-test -> development) adds pytest integration tests under tests/integration/, with their own README. It does not change the root README, so after it merges the root README would not mention them. [code-derived] Basis No clause governs this; code-derived. Merged state built by merging #32 (head b5cbcf7) into development (cef77bc), no conflicts. #32 changes only tests/integration/ and adds .gitignore. Raised by Review by the repository owner. Change README.md, Development: a short "Integration tests (optional)" subsection pointing to tests/integration/README.md. What it says is taken from the merged tree: the tests run against a local DCAF from docker/local (tests/integration/README.md; docker/local/ docker-compose.yml:21-23 maps ports 5000, 5100 and 5201, as tests/integration/config.toml expects); the clients create, get and delete R1 provisioning sessions and data reporting configurations, R2 data reporting sessions (plus creating a report) and R6 event subscriptions (tests/integration/clients/*.py); there is no update call. No instruction is copied from the sub-folder README. The rest of the README was checked against the merged tree and is unchanged by #32. Verification T0: code_check.py against the previous README on this branch: 8 of 8 code blocks byte-identical, none added. The tests were not run. Not in this change tests/integration/README.md itself; any code.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Type: documentation
Paired with: #32 (no textual conflict, either order); the README links
tests/integration/README.md, which exists once #32 is merged.Applies the common 5G-MAG README format to the root README: banner, Status/Version/Licence badges, project and issue links, an At a glance table, and the template's section order.
Instructions unchanged. All 8 code blocks, and every table row containing code, are byte-identical to the current README; no command was added, removed or changed. Checked by a script that compares the two files block by block.
Prose corrected against the code (
developmentcef77bc):TSG105-Rel18by default (meson_options.txt,lib/data-collection-service-provider/meson.build:643).Adds
.github/banner.svg(generated from the 5G-MAG repository template).Further commits:
7e9b16edocs: Running names/usr/local/etc/open5gs/dcaf.yaml(wasdcaf.conf), the file the build installs andopen5gs-dcafdreads by default (src/data-collection-af/meson.build:76,83).f4b0bcadocs: Development gains a short "Integration tests (optional)" subsection pointing totests/integration/README.md, which ci: run DCAF regression tests automatically and fix test expectations #32 adds (pytest tests that create, read and delete R1, R2 and R6 resources on a local DCAF fromdocker/local). ci: run DCAF regression tests automatically and fix test expectations #32 does not touch the root README, so the two merge in either order; the new link resolves once ci: run DCAF regression tests automatically and fix test expectations #32 is merged.