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

Pbench Documentation Site Design #1586

Merged
merged 8 commits into from
Oct 1, 2020
Merged

Pbench Documentation Site Design #1586

merged 8 commits into from
Oct 1, 2020

Conversation

anishaswain
Copy link
Collaborator

@anishaswain anishaswain commented Apr 1, 2020 •
edited
Loading

Fixes #1447

The site is designed using PatternFly 4 with some slight CSS modifications.
Pbench website development guide

Wire Frame:
pbench-wires.pdf

Demo: https://anisha1234.github.io/pbench/index.html

Screenshot

@anishaswain anishaswain self-assigned this Apr 1, 2020
@anishaswain anishaswain requested a review from gurbirkalsi April 1, 2020 13:29
@portante portante added this to the v0.69 milestone Apr 1, 2020
@portante portante self-requested a review April 1, 2020 16:32
@portante portante added the WIP label Apr 2, 2020
portante
portante requested changes Apr 14, 2020
View reviewed changes
Copy link
Member

@portante portante left a comment

Choose a reason for hiding this comment

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

Can you rebase this commit before we review? And if it is ready for review, can you remove the WIP label?

@anishaswain anishaswain marked this pull request as draft April 15, 2020 10:34
@anishaswain anishaswain removed the WIP label Apr 15, 2020
@anishaswain anishaswain marked this pull request as ready for review April 15, 2020 10:36
@anishaswain
Copy link
Collaborator Author

@portante The work is still in progress but we can only do progress on top of the provided reviews. So I have removed the WIP label but we can't merge it right now. Mary is providing feedback here on the current work.

@portante portante marked this pull request as draft April 15, 2020 10:41
@portante
Copy link
Member

I've set this PR to "Draft" mode so that it won't be merged until you feel it is ready.

@anishaswain anishaswain marked this pull request as ready for review April 15, 2020 13:47
@anishaswain anishaswain marked this pull request as draft April 15, 2020 13:47
@anishaswain anishaswain marked this pull request as ready for review May 4, 2020 21:42
@portante portante modified the milestones: v0.69, v0.70 Jun 20, 2020
@lgtm-com

This comment has been minimized.

Sign in to view
@lgtm-com

This comment has been minimized.

Sign in to view
@lgtm-com

This comment has been minimized.

Sign in to view
portante
portante requested changes Sep 28, 2020
View reviewed changes
Copy link
Member

@portante portante left a comment

Choose a reason for hiding this comment

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

Looks really good, and much more approachable!

index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
learn.html Outdated Show resolved Hide resolved
learn.html Outdated Show resolved Hide resolved
learn.html Outdated Show resolved Hide resolved
learn.html Outdated Show resolved Hide resolved
learn.html Show resolved Hide resolved
portante
portante requested changes Sep 28, 2020
View reviewed changes
Copy link
Member

@portante portante left a comment

Choose a reason for hiding this comment

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

One more comment ...

doc.html Outdated
<br>change the directory structure of the results (see the <a href="#web">Accessing results on the web</a> section below for details).
</p>
<p class="info_text" style="text-align:justify">
<b>XXX pbench-cleanup</b>
Copy link
Member

Choose a reason for hiding this comment

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

I believe pbench-cleanup is no longer a CLI command we offer. Let's just remove that. @ndokos, can you remove the reference to it in the Makefile?

dbutenhof
dbutenhof reviewed Sep 28, 2020
View reviewed changes
doc.html Outdated Show resolved Hide resolved
doc.html Outdated Show resolved Hide resolved
doc.html Outdated Show resolved Hide resolved
doc.html Show resolved Hide resolved
doc.html Outdated Show resolved Hide resolved
doc.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
portante
portante approved these changes Sep 30, 2020
View reviewed changes
Copy link
Member

@portante portante left a comment

Choose a reason for hiding this comment

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

Ship it!

portante
portante approved these changes Sep 30, 2020
View reviewed changes
Copy link
Member

@portante portante left a comment

Choose a reason for hiding this comment

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

Still think we should ship it!

ndokos
ndokos requested changes Oct 1, 2020
View reviewed changes
Copy link
Member

@ndokos ndokos 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 just the tip of the iceberg I'm afraid. I've seen a lot more (some of them existing in the current docs, some not) and it's hard to say which ones should be fixed now and which ones should be left for later.

index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
start.html Outdated Show resolved Hide resolved
start.html Outdated Show resolved Hide resolved
@portante
Copy link
Member

portante commented Oct 1, 2020 •
edited
Loading

@ndokos, are these comments applicable to the existing documentation as well as to what @anishaswain changed here? The spirit of this PR is to implement a new site design for the documentation.

These last set of comments seem to apply equally to the existing documentation.

If you don't object, can we merge this work, and then follow up with a PR to make these documentation changes?

@anishaswain anishaswain requested a review from ndokos October 1, 2020 12:23
@portante portante merged commit 5095016 into distributed-system-analysis:gh-pages Oct 1, 2020
@portante portante mentioned this pull request Oct 22, 2020
Closed
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dbutenhof dbutenhof dbutenhof approved these changes

@portante portante portante approved these changes

@ndokos ndokos ndokos approved these changes

@gurbirkalsi gurbirkalsi Awaiting requested review from gurbirkalsi

Assignees

@anishaswain anishaswain

Labels
Documentation enhancement
Projects
None yet
Milestone
v0.70
Development

Successfully merging this pull request may close these issues.
4 participants
@anishaswain @portante @ndokos @dbutenhof