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

github.io documentation restructuring #909

Merged
merged 17 commits into from
Feb 29, 2024

Conversation

kta-intel
Copy link
Collaborator

Description: This PR restructures the current github.io. Contents are intact and migrated from the old documentation with minor updates and additions

Objective:

  1. Easier for a user to navigate (get started guide, feature list, etc.)
  2. Easier for developer team to maintain and expand upon
  3. Better aligns with other Intel AI software documentation while drawing inspiration from ecosystem FL documentation

Added:

  1. get started guide (using existing examples and installation instructions)
  2. release notes (keep users in the loop with changes in a more self-contained way)
  3. blogs & publications (for better promotion to dev community)
  4. features (collated existing docs into one place to better highlight features)

@kta-intel kta-intel marked this pull request as draft January 19, 2024 20:56
Signed-off-by: kta-intel <[email protected]>
@kta-intel kta-intel marked this pull request as ready for review January 26, 2024 21:37
@psfoley psfoley requested a review from nammbash February 1, 2024 17:45
Copy link
Collaborator

@porteratzo porteratzo left a comment

Choose a reason for hiding this comment

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

Looks good to me

Copy link
Collaborator

@manuelhsantana manuelhsantana left a comment

Choose a reason for hiding this comment

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

This is a fantastic PR! The reorganization of the documentation is a massive improvement and it's clear that a lot of effort has been put into this. The structure is much more intuitive and user-friendly, which will be appreciated by all the users!.
I really like the sections:

  • Features page, the addition of the Features/ aggregation algorithms <- liked!
  • Contributing to OpenFL <- especially this
  • Releases
  • Blog and Publications

I only request changes on minor comments or typos.
This is a significant contribution. Well done Kevin!

docs/requirements-docs.txt Outdated Show resolved Hide resolved
docs/get_started/examples.rst Outdated Show resolved Hide resolved
docs/developer_guide/running_the_federation.tutorial.rst Outdated Show resolved Hide resolved
docs/developer_guide/experimental_features.rst Outdated Show resolved Hide resolved
@manuelhsantana
Copy link
Collaborator

This is a fantastic PR! The reorganization of the documentation is a massive improvement and it's clear that a lot of effort has been put into this. The structure is much more intuitive and user-friendly, which will be appreciated by all the users!. I really like the sections:

  • Features page, the addition of the Features/ aggregation algorithms <- liked!
  • Contributing to OpenFL <- especially this
  • Releases
  • Blog and Publications

I only request changes on minor comments or typos. This is a significant contribution. Well done Kevin!

I realized I forgot to mention something in my previous comment. I've been thinking that perhaps we should consider adding a [+] icon to indicate where sections can be expanded. However, I'm a bit torn on this. On one hand, it could enhance user navigation and ensure that no sections are overlooked. On the other hand, it might detract from the minimalist aesthetic that I really appreciate in the current design. It's a minor point, but I thought it was worth bringing up for discussion. Anyway, great job on this PR!

Copy link
Collaborator

@manuelhsantana manuelhsantana left a comment

Choose a reason for hiding this comment

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

Already reviewed and look great and ready for the merge!

@psfoley
Copy link
Contributor

psfoley commented Feb 29, 2024

@kta-intel once the conflicts with docs/workflow_interface.rst are resolved, I will merge this

@kta-intel
Copy link
Collaborator Author

I think it should be good now. I'm not sure the exact cause of the merge conflict, but pulling the original /docs/workflow_interface.rst, merging the main dev branch, then deleting it seemed to resolve it.

Ran a final check to make sure everything ran as it did before.

Thanks again everyone for the review!

@psfoley psfoley merged commit a61c7a0 into securefederatedai:develop Feb 29, 2024
26 checks passed
manuelhsantana pushed a commit that referenced this pull request Jul 10, 2024
* updating documentation template

Signed-off-by: kta-intel <[email protected]>

* WIP quickstart guide

Signed-off-by: kta-intel <[email protected]>

* documentation updates

Signed-off-by: kta-intel <[email protected]>

* more updates to getting started

Signed-off-by: kta-intel <[email protected]>

* more get_started docs

Signed-off-by: kta-intel <[email protected]>

* getting_started updates

Signed-off-by: kta-intel <[email protected]>

* documentation overhaul. restructuring github.io

Signed-off-by: kta-intel <[email protected]>

* lint fix

Signed-off-by: kta-intel <[email protected]>

* addressing various comments, fixing typos, code snippets, etc

Signed-off-by: kta-intel <[email protected]>

* add /docs/workflow_interface.rst

Signed-off-by: kta-intel <[email protected]>

* remove /docs/workflow_interface.rst

Signed-off-by: kta-intel <[email protected]>

* add add /docs/workflow_interface.rst

Signed-off-by: kta-intel <[email protected]>

* remove /docs/workflow_interface.rst

Signed-off-by: kta-intel <[email protected]>

* fixing typo in workflowinterface.rst

Signed-off-by: kta-intel <[email protected]>

---------

Signed-off-by: kta-intel <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants