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

Update documentation #293

Merged
merged 14 commits into from
Jul 14, 2020
Merged

Update documentation #293

merged 14 commits into from
Jul 14, 2020

Conversation

glensc
Copy link
Contributor

@glensc glensc commented Jul 11, 2020

  1. Direct user to readme from run list view, rather having instructions duplicated
  2. Update xhgui releases link (preinheimer -> perftools)
  3. Briefly describe how php-profiling works and how to import jsonlines files.
  4. Remove extension install instructions (profiling data is not the goal of this project)
  5. Update profiling logic to be abstract and how to do offline profiling
  6. Remove ext-dom phpunit requirement (the list IMHO incomplete, and phpunit is not required for application run)
  7. Move file saver block: Update file saver documentation php-profiler#19
  8. Move profiling.enable docs: Import profiler.enable documentation from xhgui project php-profiler#20
  9. Move profile.simple_url docs: Import simple url config from xhgui readme php-profiler#22
  10. Move ignored_functions docs: Import ignored_functions from xhgui documentation php-profiler#23

@glensc glensc requested a review from markstory July 11, 2020 16:09
@glensc glensc self-assigned this Jul 11, 2020
@glensc
Copy link
Contributor Author

glensc commented Jul 11, 2020

@markstory what is the proper capitalization of XHGUI? I want to be consistent in the documentation.

  1. XHGui
  2. XHGUI
  3. Xhgui

Profiling extension detail is not part of this project
Running unit tests is not main application concern and the list is most likely incomplete.
@glensc
Copy link
Contributor Author

glensc commented Jul 11, 2020

the rewritten file saver block documentation in profiler package: perftools/php-profiler#19

@glensc glensc marked this pull request as ready for review July 12, 2020 07:00
@glensc
Copy link
Contributor Author

glensc commented Jul 12, 2020

Moving profiling.enable docs: perftools/php-profiler#20

@markstory
Copy link
Member

what is the proper capitalization of XHGUI?

I've tried to use XHGui in the past, but we can always change it if that is an oddly shaped word.

@glensc
Copy link
Contributor Author

glensc commented Jul 13, 2020

there are profiler related config options in this project:

config/config.default.php:    'profiler.options' => array(),

these should be removed from here, but not sure when :)

@glensc
Copy link
Contributor Author

glensc commented Jul 13, 2020

This is in my opinion good enough to merge. @perftools/maintainers @Krinkle WDYT?

Copy link
Contributor

@Krinkle Krinkle left a comment

Choose a reason for hiding this comment

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

LGTM. Also +1 for "XHGui" as the canonical spelling I've personally used/preferred.

@glensc glensc merged commit bead5b3 into perftools:master Jul 14, 2020
@glensc glensc deleted the docs-update branch July 14, 2020 08:23
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.

None yet

3 participants