[docs] Add Resources folder with PCAPs and Useful Links sections

[uri200]

Signed-off-by: Oriol Batalla obatalla@fb.com

Summary

Add a new section called Resources where to drop useful links, files, or information for Magma users.

Added PCAPs with GX/GY and inbound roaming examples

Test Plan

run docusaurus locally

Additional Information

• This change is backwards-breaking

[github-actions]

Thanks for opening a PR! 💯

Howto

Reviews. The "Reviewers" listed for this PR are the Magma maintainers who will shepherd it.

Checks. All required CI checks must pass before merge.

Merge. Once approved and passing all CI checks, use the ready2merge label to indicate the maintainers can merge your PR.

More info

All commits must be signed off. This is enforced by the DCO check.

Please take a moment to read through the Magma project's

• Contributing conventions for norms around contributed code

If this is your first Magma PR, also consider reading

• Developer onboarding for onboarding as a new Magma developer
• Development workflow for guidance on your first pull request
• CI checks for points of contact for failing or flaky CI checks

[emakeev]

This is a great idea, we are always searching for pcaps & protocol examples for unit tests & implementation specifics.

[themarwhal]

Some of those PCAP collect data seems like an incomplete sentence :D

[uri200]

good catch! it was hidden on my IDE far far in the right

[hcgatewood]

Love the additions, thanks @uri200! Two requests

• We're trying to keep the number of top-level sections as small as possible. For the pcaps etc, please put those into a subsection under Technical Reference. For the links, please put them somewhere in the intro/getting started section
• Is the inline HTML necessary in the Markdown files? e.g. the <br />

[uri200]

Love the additions, thanks @uri200! Two requests

• We're trying to keep the number of top-level sections as small as possible. For the pcaps etc, please put those into a subsection under Technical Reference. For the links, please put them somewhere in the intro/getting started section
• Is the inline HTML necessary in the Markdown files? e.g. the <br />

Hey @hcgatewood, initially I had it in Technical Resources, then I moved it to How Tos. After discussing with @talkhasib we thought it didn't belong to any of the categories displayed. I am fine with any location. Should we move Technical Reference and Usage under Resources?

For the <br /> the reason is I wanted to have the filename separated from the description. Adding that as a title didn't satisfied it since it was leaving a big gap. And no without the <br />, the same line was used for both link and description. See below the different options. I am open to chose between the current or any of those 2 if you like them better.

[hcgatewood]

So the idea is to separate "Usage" as basic information for operators, and "Technical Reference" as more in-depth information for SIs, VARs, and devs. So I would say this info would fit best under Technical Reference > General subsection

For the Markdown -- just do something like this, maybe even as a list

• Example 1. Foo bar.
• Example 2. Apple banana.

[uri200]

So the idea is to separate "Usage" as basic information for operators, and "Technical Reference" as more in-depth information for SIs, VARs, and devs. So I would say this info would fit best under Technical Reference > General subsection

For the Markdown -- just do something like this, maybe even as a list

• Example 1. Foo bar.
• Example 2. Apple banana.

Techincal Reference/General sounds good to me if @talkhasib doesn't have any problem with it.

[uri200]

Found a better way for the entries

[talkhasib]

under Reference/General sounds good

[uri200]

Done, added it to Technical Reference section. See picture on the description of the PR

[hcgatewood]

Thanks for adding. Couple small comments before merge

[hcgatewood]

For both files: these timestamps aren't necessary / won't get updated when people make changes. Docusaurus has a feature to add these automatically, so look into that if you're interested in providing this affordance

[hcgatewood]

For both ids: prefix them both with either dev_ or ref_ for namespacing purposes

[hcgatewood]

Add some minor info about what these links contain

[codecov]

Codecov Report

Merging #6778 (83a20fb) into master (4f45a0d) will decrease coverage by 2.47%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #6778      +/-   ##
==========================================
- Coverage   64.45%   61.97%   -2.48%     
==========================================
  Files         671      521     -150     
  Lines       46527    35696   -10831     
  Branches     1318        0    -1318     
==========================================
- Hits        29990    22124    -7866     
+ Misses      13120    10473    -2647     
+ Partials     3417     3099     -318     

Flag	Coverage Δ
cloud_lint	65.48% <ø> (+0.01%)	⬆️
feg-lint	56.55% <ø> (+0.01%)	⬆️
lte-test	?

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...way/python/magma/enodebd/state_machines/enb_acs.py
lte/gateway/python/magma/enodebd/stats_manager.py
...ay/python/magma/magmad/check/network_check/ping.py
...ateway/python/magma/mobilityd/ip_allocator_pool.py
...agma/enodebd/device_config/enodeb_configuration.py
lte/gateway/python/magma/mobilityd/mac.py
...subscriberdb/protocols/diameter/application/s6a.py
...python/magma/policydb/servicers/policy_servicer.py
.../gateway/python/magma/subscriberdb/rpc_servicer.py
...gateway/python/magma/common/serialization_utils.py
... and 142 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4f45a0d...83a20fb. Read the comment docs.