Skip to content

Conversation

@Borda
Copy link
Collaborator

@Borda Borda commented Aug 11, 2022

What does this PR do?

Make a dummy doc and set up related CI/CD jobs...
For preserving continuity, we use symlinks to the existing pages. When all is settled up, we will project the real pages via link to the new location and sunset the old docs location.
The cleaning requirements are also separated in #14216

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

This is a preparation stage for docs unification. If you want to edit/update docs for ongoing documentation, do it in source-app or source-pytorch. Otherwise, if the changes are related to the future/fused docs, please rename/move the existing symlink or make a new file where you can still copy-paste the page content...

cc @Borda

@Borda Borda added this to the pl:future milestone Aug 11, 2022
@Borda Borda self-assigned this Aug 11, 2022
@Borda Borda force-pushed the docs/merge branch 4 times, most recently from 329b3af to eb2bc8e Compare August 15, 2022 19:33
@Borda
Copy link
Collaborator Author

Borda commented Aug 15, 2022

ok, one remaining issue lest is with unification of templates:

Extension error (pt_lightning_sphinx_theme.extensions.lightning):
Handler <function process_card_nodes at 0x7f0acfce40d0> for event 'doctree-resolved' threw an exception (exception: 'BuildEnvironment' object has no attribute 'all_cardnodes')
make: *** [Makefile:19: html] Error 2

@github-actions github-actions bot added the app (removed) Generic label for Lightning App package label Aug 16, 2022
@mergify mergify bot added the ready PRs ready to be merged label Aug 16, 2022
Copy link
Contributor

@akihironitta akihironitta left a comment

Choose a reason for hiding this comment

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

(I guess this has been discussed already somewhere and/or can be discussed/polished later in follow-up PRs, but)

IMHO, mixing both app and pl and having both at the same directory level seems confusing, e.g.

docs/source-lit/accelerators  # <- pl
docs/source-lit/strategies    # <- pl
...
docs/source-lit/code_samples  # <- app
docs/source-lit/workflows     # <- app
...

@Borda Borda requested a review from akihironitta August 18, 2022 18:34
@Borda
Copy link
Collaborator Author

Borda commented Aug 18, 2022

IMHO, mixing both app and pl and having both at the same directory level seems confusing, e.g.

This is just init state, and all shall be restructured by @Felonious-Spellfire in following PRs

@Borda Borda force-pushed the docs/merge branch 2 times, most recently from e2f7976 to 75b35c7 Compare August 19, 2022 08:08
@Borda Borda requested a review from yurijmikhalevich August 23, 2022 06:40
@akihironitta akihironitta force-pushed the docs/merge branch 2 times, most recently from 026813f to 95d7b18 Compare August 27, 2022 12:10
@Borda Borda marked this pull request as draft August 29, 2022 22:12
@Borda Borda requested a review from yurijmikhalevich August 29, 2022 22:59
@Borda Borda marked this pull request as ready for review August 29, 2022 22:59
@Borda Borda enabled auto-merge (squash) August 29, 2022 23:00
@lexierule lexierule disabled auto-merge August 30, 2022 13:24
@lexierule lexierule merged commit 208bf6f into master Aug 30, 2022
@lexierule lexierule deleted the docs/merge branch August 30, 2022 13:25
@carmocca carmocca modified the milestones: pl:future, pl:1.8 Sep 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

app (removed) Generic label for Lightning App package ready PRs ready to be merged

Projects

No open projects
Status: Done

Development

Successfully merging this pull request may close these issues.

9 participants