[GitHub] [skywalking-eyes] kezhenxu94 commented on pull request #41: [Docs] Add a PlantUML activity diagram of header fixing mechanism

[GitBox <gi...@apache.org>]

kezhenxu94 commented on pull request #41:
URL: https://github.com/apache/skywalking-eyes/pull/41#issuecomment-879082286


   > I took some time to create an activity diagram in descriptive PlantUML syntax which shows how the current header fixing mechanism works. I think this could simplify future discussions about the header fixing mechanism and its technical requirements.
   
   Thanks for doing this, @emschu 
   
   > 
   > My original idea was to add this to PR #40 which is merged already, therefore I create this new PR.
   
   It's better to do one thing in one PR, as #40 is complete enough on its own and this is a separate doc polish, let's continue this independently.
   
   > Feel free to refuse this PR, if the diagram or the SVG file is not desired (in this repository) or if you think this does not belong here.
   
   The diagram is very useful for new contributors, I have some comments:
   
   - What's the relation between the `.plantuml` file and `.svg` file, is `.svg` generated from `.plantuml`?
   - Can you link to the diagram in the README.md or embed the diagram in README.md?
   
   
   @wu-sheng as `.plantuml` / `.svg` is a kind of "source code" and their size is small, I think it's OK to host it here for easy maintenance, what's your opinion?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org