search

odpi / egeria-docs

Documentation repository for the Egeria project.
https://egeria-project.org
Other
22 stars 30 forks source link

Move the user interface content into a more natural place #285

Open davidradl opened 2 years ago

davidradl commented 2 years ago

Current the user interface content is under a section called user interfaces. Most (probably all) of the The user interfaces information should be moved in the appropriate section- for example planning for the Ui should move to the overall planning section which would be augmented with a ui section.

adinhtdsibm commented 2 years ago

@davidradl There is already content available in egeria-docs Should we move to a new place? If yes, can you create the structure and then I can work on it. Also, I do see more content here, egeria, should we also migrate them? or is it all done?

davidradl commented 2 years ago

Hi @adinhtdsibm the idea is to remove all or most of the top level user interface content from the docs and move the content to under planning or the other existing sections around the different activities. Does that make sense?

davidradl commented 2 years ago

@adinhtdsibm the SLT meeting today discussed UI documentation. We agreed that the top level UI concepts should stay at the top level.

Then move the existing content as follows: I suggest we have a new Using the UI section under the top 'Using' section I suggest we move the planning to the 'Planning Guide' section .
I suggest under the administration section we have a new 'Configuring the UIs' section

@mandy-chessell @sarbull @planetf1 any concerns with the above?

planetf1 commented 2 years ago

@davidradl The meeting was the 'TSC' meeting (just in case you hear the term @adinhtdsibm )

On the UI changes overall I agree.

Also the content relating to building -- that could be regarded as 'before' admin but after 'planning'. The similar content for egeria is in tutorials - it's almost like we need a seperate 'build' or 'get' section (we didn't discuss this yesterday)

I also noticed that the build/run section talks about setting the environment variable, then building. However this may confuse - as the environment variable is a runtime setting -- it must be available in the context from there the npm run prod or similar is run. So whilst it can be explained earlier in terms of tenancy, we need to keep the setting close to the launch of the UI process. It needs to be clear what gets done, where, when.

Finally under build/run we also have other options. They aren't well integrated now (except in tutorials) but perhaps should be ie a choice of

adinhtdsibm commented 2 years ago

@planetf1 @davidradl Thanks for the updates. I will go through the details and update accordingly.