Integrating repository docs into main documentation site

[joewxboy]

This discussion is meant to capture issues, questions, and requirements related to this effort.

From a high level, the tasks appear to include:

1. Identifying all repositories in this project with documentation (repo docs)
2. Creating folders in open-horizon.github.io/docs corresponding to the literal names of repo docs (see illustration below)
3. Ensuring repo docs are in proper format, with front matter, and in /docs folder (make sure the "s" is there)
4. Ensure all folders have index.md file and no orphans exist (orphan checking may have to happen after integration)
5. Creating GHA in repo docs to copy files over on merge containing files in /docs
6. Possibly also copy over on commits for specific branches in those branches, but this is nice-to-have
7. Possible linting action when files are copied from repo docs, nice-to-have

The initial effort was started by this issue: #29

[Sukriti-sood]

@joewxboy I have opened issue as directed by you in last comment of issue #29 .

[joewxboy]

This image illustrates the open-horizon.github.io repo's "docs" folder tree and where the anax repo's "docs" folder would go in the documentation tree:

[joewxboy]

Status update:

1. Identifying all repositories in this project with documentation (repo docs)
   We still need to do this. Currently we've identified devops and exchange-api. Others?
2. Completed. Creating folders in open-horizon.github.io/docs corresponding to the literal names of repo docs (see illustration below)
   This is handled automatically by the GHA.
3. Ensuring repo docs are in proper format, with front matter, and in /docs folder (make sure the "s" is there)
   At least one repo, exchange-api, needs this. Any others?
4. Ensure all folders have index.md file and no orphans exist (orphan checking may have to happen after integration)
5. Completed. Creating GHA in repo docs to copy files over on merge containing files in /docs
   PR has been merged. Acceptance testing done.
6. Possibly also copy over on commits for specific branches in those branches, but this is nice-to-have
7. Possible linting action when files are copied from repo docs, nice-to-have
   Covered in related issue for developer preview GHA. (add link)

[Sukriti-sood]

2nd one is not needed... will be done by gha.

yes, gha in the anax docs is made keeing this point.

Can you elaborate point 6.

[joewxboy]

Point 6 is confusing. Not 100% sure what I meant. :smh:

If I had to guess, I'd say this is about the developer preview GHA.