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

Import and change appropriately the pyramid docs regards paste.translogg... #70

Closed
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
4 participants
@kpinc
Contributor

kpinc commented Aug 11, 2014

Note that while the docs build fine I did not actually execute the code!

@mcdonc

This comment has been minimized.

Show comment
Hide comment
@mcdonc

mcdonc Aug 13, 2014

Member

The index.rst path maybe needs to be reworked so that it doesn't try to explain both logging config and middleware config at once. I'd suggest something like this structure:

Access Logging
==============

Explain what translogger is and apologize for it being unavailable in py3

Logging to the Console Using Python
-----------------------------------

  No special logging config, depend on setup_console_handler being true by
  default.

Logging to the Console Using PasteDeploy
----------------------------------------

  No special logging config, depend on setup_console_handler being true by
  default.

Logging to a File Using Python
------------------------------

  Show how to configure the wsgi logger via python.

Logging to a File Using PasteDeploy
------------------------------------

  Show how to configure the wsgi logger via pastedeploy.
Member

mcdonc commented Aug 13, 2014

The index.rst path maybe needs to be reworked so that it doesn't try to explain both logging config and middleware config at once. I'd suggest something like this structure:

Access Logging
==============

Explain what translogger is and apologize for it being unavailable in py3

Logging to the Console Using Python
-----------------------------------

  No special logging config, depend on setup_console_handler being true by
  default.

Logging to the Console Using PasteDeploy
----------------------------------------

  No special logging config, depend on setup_console_handler being true by
  default.

Logging to a File Using Python
------------------------------

  Show how to configure the wsgi logger via python.

Logging to a File Using PasteDeploy
------------------------------------

  Show how to configure the wsgi logger via pastedeploy.
@stevepiercy

This comment has been minimized.

Show comment
Hide comment
@stevepiercy

stevepiercy Dec 22, 2015

Member

I'm trying to rewrite this PR.

@mcdonc It looks like paste.translogger had some work on py3 compatibility. Is an apology still needed?
https://bitbucket.org/ianb/paste/history-node/a159cd816e01/paste/translogger.py?at=default

Also are you suggesting that the two sections "Logging" and @kpinc's "Web Traffic Logging With Paste's TransLogging Middleware" both be combined into a single section "Access Logging" with four subsections, or something else?

Member

stevepiercy commented Dec 22, 2015

I'm trying to rewrite this PR.

@mcdonc It looks like paste.translogger had some work on py3 compatibility. Is an apology still needed?
https://bitbucket.org/ianb/paste/history-node/a159cd816e01/paste/translogger.py?at=default

Also are you suggesting that the two sections "Logging" and @kpinc's "Web Traffic Logging With Paste's TransLogging Middleware" both be combined into a single section "Access Logging" with four subsections, or something else?

@bertjwregeer

This comment has been minimized.

Show comment
Hide comment
@bertjwregeer

bertjwregeer Mar 16, 2017

Member

@stevepiercy or @kpinc are you still working on this? If not I will close out this PR.

Member

bertjwregeer commented Mar 16, 2017

@stevepiercy or @kpinc are you still working on this? If not I will close out this PR.

@stevepiercy

This comment has been minimized.

Show comment
Hide comment
@stevepiercy

stevepiercy Mar 16, 2017

Member

I am awaiting feedback from @mcdonc or whoever answers my questions for further direction.

Member

stevepiercy commented Mar 16, 2017

I am awaiting feedback from @mcdonc or whoever answers my questions for further direction.

@bertjwregeer

This comment has been minimized.

Show comment
Hide comment
@bertjwregeer

bertjwregeer Mar 16, 2017

Member

I am trying to understand what apology you are referring to. I think adding more information about logging would be great, but adding it to the current index.rst I don't think is a good idea.

The docs in general need a good once over, clean them up, add appropriate sections, and make it flow better. Not sure if this is the right ticket or not.

Member

bertjwregeer commented Mar 16, 2017

I am trying to understand what apology you are referring to. I think adding more information about logging would be great, but adding it to the current index.rst I don't think is a good idea.

The docs in general need a good once over, clean them up, add appropriate sections, and make it flow better. Not sure if this is the right ticket or not.

@stevepiercy

This comment has been minimized.

Show comment
Hide comment
@stevepiercy

stevepiercy Mar 16, 2017

Member

Explain what translogger is and apologize for it being unavailable in py3

...because I see some recent work indicates it is available for py3. I'm not absolutely sure whether it is or not available for py3, but if it is available, then no apology is needed.

For this ticket, I think you're right: it makes sense to break out logging from the index. I mean, an index page is supposed to be an index of content, not the content itself (unless of course it's a SPD or a Single Page Documentation).

If there are other structural changes, I'd suggest creating a Task List in a new ticket. Bite size morsels are more easily consumed.

- [ ] Task incomplete
- [x] Task complete
- [ ] ~~Task cancelled~~
  • Task incomplete
  • Task complete
  • Task cancelled
Member

stevepiercy commented Mar 16, 2017

Explain what translogger is and apologize for it being unavailable in py3

...because I see some recent work indicates it is available for py3. I'm not absolutely sure whether it is or not available for py3, but if it is available, then no apology is needed.

For this ticket, I think you're right: it makes sense to break out logging from the index. I mean, an index page is supposed to be an index of content, not the content itself (unless of course it's a SPD or a Single Page Documentation).

If there are other structural changes, I'd suggest creating a Task List in a new ticket. Bite size morsels are more easily consumed.

- [ ] Task incomplete
- [x] Task complete
- [ ] ~~Task cancelled~~
  • Task incomplete
  • Task complete
  • Task cancelled
@stevepiercy

This comment has been minimized.

Show comment
Hide comment
@stevepiercy

stevepiercy Mar 16, 2017

Member

@bertjwregeer to make progress on this ticket, how about we create a new branch off of Pylons/waitress/master, say Pylons/waitress/logging. Then merge @kpinc's branch into the new branch. Then I can push commits to it without interfering with master, while preserving his contributions. How's that sound?

Member

stevepiercy commented Mar 16, 2017

@bertjwregeer to make progress on this ticket, how about we create a new branch off of Pylons/waitress/master, say Pylons/waitress/logging. Then merge @kpinc's branch into the new branch. Then I can push commits to it without interfering with master, while preserving his contributions. How's that sound?

@stevepiercy

This comment has been minimized.

Show comment
Hide comment
@stevepiercy

stevepiercy May 19, 2018

Member

Alternatively, let's merge this, then I can break out sections into separate pages in the docs? ping @bertjwregeer

Member

stevepiercy commented May 19, 2018

Alternatively, let's merge this, then I can break out sections into separate pages in the docs? ping @bertjwregeer

@bertjwregeer

This comment has been minimized.

Show comment
Hide comment
@bertjwregeer

bertjwregeer Sep 6, 2018

Member

@stevepiercy do you want to champion this change still?

Member

bertjwregeer commented Sep 6, 2018

@stevepiercy do you want to champion this change still?

@stevepiercy

This comment has been minimized.

Show comment
Hide comment
@stevepiercy

stevepiercy Sep 6, 2018

Member

@bertjwregeer yup. Created new branch under Pylons so I can do the necessary work there instead of here.

Member

stevepiercy commented Sep 6, 2018

@bertjwregeer yup. Created new branch under Pylons so I can do the necessary work there instead of here.

@stevepiercy

This comment has been minimized.

Show comment
Hide comment
@stevepiercy

stevepiercy Sep 6, 2018

Member

Moved work under the branch doc_translogger in PR #205. Closing this PR. Will pick up work on that branch.

Member

stevepiercy commented Sep 6, 2018

Moved work under the branch doc_translogger in PR #205. Closing this PR. Will pick up work on that branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment