Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Put the namespaces(packages) into the json files #39593

Merged
merged 7 commits into from
Apr 9, 2024

Conversation

JimSuplizio
Copy link
Member

@JimSuplizio JimSuplizio commented Apr 8, 2024

For whatever reason, instead of storing the namespaces (packages) in the docs metadata json files, they were stored in separate files. While I've already gone ahead and prepopulated the json files with the namespaces from their txt files, the automation that creates the txt files was still there. Worse, was that this automation ran separately from the docs processing code. This PR does the following:

  1. Remove the creation and use of the .txt files.
  2. Changed the functions that pulled the namespaces to return the list of namespaces rather than writing them out to txt files.
  3. Modified docs processing, implemented the GetDocsMsDevLanguageSpecificPackageInfoFn which now matches what was recently done for Python, making the two languages similar in processing.

Note: The docindex.yml files will be revered prior to this PR being merged. They're just there so I can test the changes without updating the metadata files in the docs repository during testing. Ditto for the ci.yml file changes for MSDocs publishing. I'd needed to add them back to test the json creation and namespace population on release.

Also of note: I know they're called packages in Java, not namespaces. The reason I'm using namespaces internally is so that when someone is looking at docs generation, it's the same across the 3 languages that use them, java, net and python.

@JimSuplizio JimSuplizio added Docs Central-EngSys This issue is owned by the Engineering System team. labels Apr 8, 2024
@JimSuplizio JimSuplizio self-assigned this Apr 8, 2024
@JimSuplizio JimSuplizio marked this pull request as ready for review April 8, 2024 20:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Central-EngSys This issue is owned by the Engineering System team. Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants