Skip to content
This repository has been archived by the owner on Mar 1, 2024. It is now read-only.

New general docs page/ToC + new security page. #254

Merged
merged 6 commits into from
Jun 8, 2023
Merged

New general docs page/ToC + new security page. #254

merged 6 commits into from
Jun 8, 2023

Conversation

MWillWallT
Copy link
Contributor

Relevant components:

  • Signalling server
  • Frontend library
  • Frontend UI library
  • Matchmaker
  • Platform scripts
  • SFU
  • Docs

Problem statement:

The current repo has no primary/general docs page. Additionally, we provide little to no information in how users can improve the security of their deployments.

Solution

This PR improves documentation layout in the repo, as well as adds a new page that provides suggested security improvements to user PS deployments.

All new doc pages will be accessible through the the new general docs page.

Documentation

N/A

Test Plan and Compatibility

N/A

Reword the page summary to be better descriptive.
@MWillWallT MWillWallT added the documentation Improvements or additions to documentation label Jun 8, 2023
@MWillWallT MWillWallT requested a review from lukehb June 8, 2023 05:22
Copy link
Contributor

@lukehb lukehb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few suggested changes for you.

Created and linked tickets for TO DO docs pages.
Copy link
Contributor

@lukehb lukehb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@lukehb lukehb merged commit 83e21b5 into EpicGames:master Jun 8, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Development

Successfully merging this pull request may close these issues.

3 participants