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.

Sign up for GitHub

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

Jump to bottom

Docs updates #6264

Merged
merged 22 commits into from
Aug 14, 2023
Merged

Docs updates #6264

merged 22 commits into from
Aug 14, 2023

Conversation

rmoff
Copy link
Contributor

@rmoff rmoff commented Jul 27, 2023 •
edited
Loading

  • Update deploy docs with diagrams
  • Tidy up and restructure GC docs
  • Update links from UI to point to current docs pages instead of relying on redirects
  • Add content to how-to index page
  • Docs nits

@rmoff rmoff added docs Improvements or additions to documentation exclude-changelog PR description should not be included in next release changelog minor-change Used for PRs that don't require issue attached labels Jul 27, 2023
@github-actions
Copy link

github-actions bot commented Jul 27, 2023 •
edited
Loading

🎊 PR Preview 29f72bc has been successfully built and deployed to https://treeverse-lakeFS-preview-pr-6264.surge.sh

🕐 Build time: 0.016s

🤖 By surge-preview

@rmoff rmoff mentioned this pull request Jul 27, 2023
Closed
@rmoff rmoff requested a review from N-o-Z July 27, 2023 14:08
@ozkatz
Copy link
Collaborator

ozkatz commented Jul 27, 2023

Overall looks good!! will wait for the conflicts to be resolved

johnnyaug and others added 6 commits July 27, 2023 20:24
@johnnyaug
Metaclient: handle initial commit (#6263)
353c03e
@iddoavn
Add ssl optional configuration (#6268)
a7d80e8 
* Added SSL Certificate_verfified_Failed

* add proxy configuration
Fix broken link to API doc (#6271)
3df0795
Add content to index pages of /understand (#6270)
16b2c20 
* Remove default layout metadata
- It's the only layout
- It's the default anyway
- It adds unnecessary content to the front page matter metadata for pages, making it more likely to make a mistake editing what is there

* Add content to index pages of /understand, fix a few page nits

* Always that file you forget to update 🤦🏻
Add diagrams to deploy docs
892060b 
Move GC docs into their own folder
Merge branch 'master' into docs/5470-take3
f6a5eef
@rmoff
Copy link
Contributor Author

rmoff commented Jul 27, 2023

Overall looks good!! will wait for the conflicts to be resolved

@ozkatz conflicts resolved; PTAL :)

N-o-Z
N-o-Z requested changes Jul 30, 2023
View reviewed changes
Copy link
Member

@N-o-Z N-o-Z 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! Couple of requests / remarks

Makefile Show resolved Hide resolved
docs/howto/deploy/gcp.md Outdated Show resolved Hide resolved
docs/howto/garbage-collection/index.md
nav_order: 1
has_children: false
parent: How-To
has_children: true
redirect_from:
- /reference/garbage-collection.html
- /howto/garbage-collection-index.html
Copy link
Member

Choose a reason for hiding this comment

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

Should be removed right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

what should be removed?

Copy link
Member

Choose a reason for hiding this comment

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

The line - you deleted the file docs/howto/garbage-collection-index.md, shouldn't we remove this redirect as well?

Copy link
Contributor Author

@rmoff rmoff Aug 14, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

the redirect is necessary for any external links into the existing /howto/garbage-collection-index.html page otherwise they'll get a 404.

docs/howto/garbage-collection/index.md Show resolved Hide resolved
docs/howto/garbage-collection/internals.md Show resolved Hide resolved
johnnyaug
johnnyaug suggested changes Jul 30, 2023
View reviewed changes
docs/assets/img/deploy/deploy-on-aws.excalidraw.png Outdated Show resolved Hide resolved
docs/howto/deploy/index.md Outdated Show resolved Hide resolved
docs/howto/garbage-collection/committed.md Outdated Show resolved Hide resolved
docs/howto/garbage-collection-index.md Outdated Show resolved Hide resolved
@nopcoder
Copy link
Contributor

nopcoder commented Aug 3, 2023

Remove myself from the pr as I'll not have time to address it.

@nopcoder nopcoder removed their request for review August 3, 2023 12:34
@rmoff rmoff requested review from johnnyaug and N-o-Z August 14, 2023 10:42
N-o-Z
N-o-Z reviewed Aug 14, 2023
View reviewed changes
Copy link
Member

@N-o-Z N-o-Z left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Responded - unblocking

@rmoff rmoff requested a review from N-o-Z August 14, 2023 11:46
@rmoff rmoff merged commit 0480105 into master Aug 14, 2023
34 checks passed
@rmoff rmoff deleted the docs/5470-take3 branch August 14, 2023 13:10
@rmoff rmoff mentioned this pull request Aug 16, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@johnnyaug johnnyaug johnnyaug approved these changes

@ozkatz ozkatz Awaiting requested review from ozkatz

@N-o-Z N-o-Z Awaiting requested review from N-o-Z

Assignees
No one assigned
Labels
docs Improvements or additions to documentation exclude-changelog PR description should not be included in next release changelog minor-change Used for PRs that don't require issue attached
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@rmoff @ozkatz @nopcoder @johnnyaug @N-o-Z @iddoavn