Clean up overview/intro docs

[johannaengland]

When working on #2641 I noticed that a lot of things are outdated in the documentation. I am planning on going through it with a fine comb and fix anything that sticks out to me.

Always open for disagreements on my changes.

I also found the line "For now, the key information here is the Last updated field of the top-left detail panel." in getting_started.rst, while I cannot find such a field in the picture below it. So that would need to be changed, but I don't know to what.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 57.18%. Comparing base (adae194) to head (d129aed).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2827   +/-   ##
=======================================
  Coverage   57.18%   57.18%           
=======================================
  Files         568      568           
  Lines       41299    41299           
=======================================
  Hits        23615    23615           
  Misses      17684    17684           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

Test results

     12 files       12 suites   11m 20s ⏱️
3 312 tests 3 312 ✔️ 0 💤 0 ❌
9 411 runs  9 411 ✔️ 0 💤 0 ❌

Results for commit d129aed.

♻️ This comment has been updated with latest results.

[hmpf]

This is a big job so you might want to not eat the entire elephant at once!

[johannaengland]

This is a big job so you might want to not eat the entire elephant at once!

Yes, this is why this PR is only about the section overview and intro and I will open new PRs for other sections

[johannaengland]

Thanks for approving @hmpf and @stveit, but does anyone of you have an answer to the question I asked in the description of the PR?

[lunkwill42]

I also found the line "For now, the key information here is the Last updated field of the top-left detail panel." in getting_started.rst, while I cannot find such a field in the picture below it. So that would need to be changed, but I don't know to what.

It seems the picture was replaced during the NAV 4.0 facelift, many years ago, but the description in the docs never changed. This is the original screenshot tthe text is actually referring to: https://github.com/Uninett/nav/blob/ac0c1297051a441e44109900963aa477d1769df7/doc/intro/ipdevinfo-switch-display.png

A key difference between the old and the new interface are the job statuses that are now shown in the lower right corner of the main ipdevinfo tab. Old versions had only the one "last update" timestamp. Now there are several, one for each configured collection job in ipdevpoll.conf.

I guess the point to get across here is really that you should keep updating the ipdevinfo page until you see job statuses start coming in with timestamps and green lamps (which signify successful job runs), just as the newer screenshot shows.

[lunkwill42]

Nice cleanup :)

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud