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

docs(data-view): Updates docs content and structure. #126

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

edonehoo
Copy link

@edonehoo edonehoo commented Nov 8, 2024

Closes #22

Changes made:

  • Combined the separate docs into one page. I think that this is helpful to contain everything in one location. We can rely on heading levels to make it more organized. Note: It seems like the docs framework or something doesn't like the restructuring I did, so it's not displaying properly as it is.
  • I removed the layouts info because it seemed a little repetitive, but I may have just not been understanding it. Definitely let me know.
  • As always, let me know if any of my interpretations seem wrong. In particular, I wasn't sure if I was editing the events context section very well

@patternfly-build
Copy link

patternfly-build commented Nov 8, 2024

@edonehoo edonehoo requested a review from fhlavac November 8, 2024 18:34
@fhlavac
Copy link
Collaborator

fhlavac commented Nov 11, 2024

Hey @edonehoo,
thank you very much for taking a look! Here are my comments:

I generally like the idea of consolidating the information into fewer pages. For the future, I am not sure if just one is enough. The future plan is also to enable more data representation possibilities than just a table - for example Card view. So what do you think about:

  • "About data view"
  • "Toolbar" (actions, selection, pagination, filters...)
  • "Table" (basic, tree, states)
    ...
  • "Cards (or whatever is added later)"

Then I am just not sure where to move the Events context since it's something for the whole data view no matter of the inner components.

"Layout" content (without example) might be worth moving to that "About" section to outline the general concept

@edonehoo
Copy link
Author

@fhlavac Ahh that's good to know!

Then I do like your suggestion:

"About data view"
"Toolbar" (actions, selection, pagination, filters...)
"Table" (basic, tree, states)
"Cards (or whatever is added later)"
Moving "Layout" content (without example) to "About"

For "events context", do you think that would also fit on the "About" page, since it's applicable to the entire data view? If not, I think it's okay to have it on its own page, so long as its a familiar concept to developers

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.

DataView content cleanup
3 participants