Skip to content

Commit

Permalink
Link to service dir instead readme in root readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mephenor committed Jul 17, 2024
1 parent b3d6232 commit c57391e
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ This is a monorepo containing all GHGA file backend microservices.

## Services:

[Download Controller Service](services/dcs/README.md)
[Encryption Key Store Service](services/ekss/README.md)
[File Ingest Service](services/fis/README.md)
[Internal File Registry Service](services/ifrs/README.md)
[Interrogation Room Service](services/irs/README.md)
[Purge Controller Service](services/pcs/README.md)
[Upload Controller Service](services/ucs/README.md)
[Download Controller Service](services/dcs)
[Encryption Key Store Service](services/ekss)
[File Ingest Service](services/fis)
[Internal File Registry Service](services/ifrs)
[Interrogation Room Service](services/irs)
[Purge Controller Service](services/pcs)
[Upload Controller Service](services/ucs)

## Development:

Expand Down
6 changes: 3 additions & 3 deletions scripts/update_readme_monorepo.py
Original file line number Diff line number Diff line change
Expand Up @@ -125,14 +125,14 @@ def read_package_description() -> str:
return DESCRIPTION_PATH.read_text()


def get_service_readmes() -> str:
def get_service_links() -> str:
"""Get links to all service readmes."""

service_readme_links = []

for service_dir in sorted(list_service_dirs()):
service_description = read_service_description(service_dir)
readme_link = service_dir.relative_to(ROOT_DIR) / "README.md"
readme_link = service_dir.relative_to(ROOT_DIR)
if "-" in service_description:
service_description = service_description.split("-")[0].strip()
service_readme_links.append(f"[{service_description}]({readme_link})")
Expand All @@ -150,7 +150,7 @@ def get_package_details() -> PackageDetails:
**header.model_dump(),
**name.model_dump(),
description=description,
service_readmes=get_service_readmes(),
service_readmes=get_service_links(),
)


Expand Down

0 comments on commit c57391e

Please sign in to comment.