Formatting on `latest` docs site is broken for blog

I'm not sure if this is affecting other locations but I see that the blog has several places where formatting is broken (only on the latest site):

• https://docs-bigbang.dso.mil/latest/blog/2-0-breaking-changes/#Values-Key-Changes : compare to https://docs-bigbang.dso.mil/2.4.1/blog/2-0-breaking-changes/#Values-Key-Changes
• https://docs-bigbang.dso.mil/latest/blog/big-bang-2-0/#Free-and-OpenSource-Core-by-Default : compare to https://docs-bigbang.dso.mil/2.4.1/blog/big-bang-2-0/#Free-and-OpenSource-Core-by-Default

mentioned in merge request !2922 (merged)

assigned to @chris.oconnell

changed iteration to Big Bang Iterations Jul 11, 2023 - Jul 24, 2023

set weight to 3

fixed istio-controlplane readme. bb docs job appears to be working again once more https://repo1.dso.mil/big-bang/team/tools/bb-docs-compiler/-/jobs/23445218. Assuming this will get pushed out to the docs site by code.il2.dso.mil

It looks like that change is published, but it doesn't appear to have fixed the issues I called out above - bullet formatting is still broken on https://docs-bigbang.dso.mil/latest/blog/2-0-breaking-changes/#Values-Key-Changes and other blogs.

Feel free to close if I'm mistaken though.

nope seems you are correct. I'll look into that. Thanks for letting us know

closed

reopened

unassigned @chris.oconnell

Unassigned because I won't have time to work this before some planned OOO time. If anyone picks this up i'd recommend starting with the Poetry version. Looks like we aren't pinning poetry to a specific version so we might try installing an older version and see if it generates the docs correctly.

Sorry, I should have reassigned to myself. I think I've pinned down the issue: MkDocs is looking for a newline before a list in order to read it as one. Looks like bumped the version from 1.3.1 to 1.4.3 in the previous commit, but we're doing so via our material version. I'm going to tinker a bit and see if I can alter that in the settings before reverting the versions. Otherwise, we might want to look into updating our docs and adding that newline. This looks like a somewhat common markdown convention so perhaps better to keep a newer version and adopt the convention.

assigned to @nicole.dupree

added statusreview label

So it looks like these issues were caused by malformed markdowns and only now apparent that mkdocs/material have become more restrictive in parsing. In light of that, I added markdown linting functionality in lieu of reverting package versions. Presently, it's only enforcing the specific formatting issue causing the errors noted herein, but could be broadened or applied across all Big Bang packages in the future, if needed.

thanks Nicole. Looks like the team that added Harbor didn't properly generate the package readme. I've opened an MR to fix this which should fix the bb docs compiler pipeline for your MR. Once we run a passing pipeline we can merge.

added 1 deleted label

removed iteration Big Bang Iterations Jul 11, 2023 - Jul 24, 2023

changed iteration to Big Bang Iterations Jul 25, 2023 - Aug 7, 2023

added teamci/pipelines label

removed 1 deleted label

added teambigbang label and removed teamci/pipelines label

changed milestone to %2.8.0