search

cryostatio / cryostatio.github.io

Website for cryostatio
https://cryostat.io/
2 stars 14 forks source link

chore(get-started): formatting of terms and phrases #150

Closed aali309 closed 10 months ago

aali309 commented 10 months ago

fixes: #120

aali309 commented 10 months ago

@andrewazores @ebaron please take a look at this and let me know. I checked some other community guides for documentation, this looks so different. i will try to look pattern-fly guide or something from Red Hat

andrewazores commented 10 months ago

Which other guides did you look at for comparison?

In any case, this is the documentation for the upstream project, so while it would perhaps be nice to have a similar look and feel to other Red Hat-sponsored projects, I don't think it's a requirement. If we do want to go that way it would be a larger change and something to look at in the longer term.

aali309 commented 10 months ago

Which other guides did you look at for comparison?

In any case, this is the documentation for the upstream project, so while it would perhaps be nice to have a similar look and feel to other Red Hat-sponsored projects, I don't think it's a requirement. If we do want to go that way it would be a larger change and something to look at in the longer term.

I looked at OpenShift and GutHub. I agree it is a larger change. What do you think of the changes? Should I continue this way? I followed @tthvo comments on the issue

andrewazores commented 10 months ago

Yes I think what you're doing here is a good improvement to the existing docs as they are. I don't see any particular need to change anything on a larger scale, certainly not in the timeframe for this upcoming 2.4 release.

If you'd like, for the goal of keeping the review loop shorter and easier, we can just retarget this PR from going into main to going into #141 or #148, and in this particular PR just work on updating and reviewing the get-started/index.md as you have done. Once that is merged then you can open a new PR again targeted at #141 / #148 to update the next document, like guides/index.md, then guides/_subsections/navigate-the-dashboard.md, etc.

andrewazores commented 10 months ago

@aali309 if you could please wrap up the last couple of review comments here, I'd like to get this merged so I can work on top of it and update the written content for the Agent without making your rebase super annoying