remove repeated snippets in Humans

[tshepang]

I don't see what the need is to include code snippets (files in this case) between the progressive steps when nothing has changed between current step and previous one. Can we just remove those to:

• avoid redundancy
• make it clearer what has changed between the steps

[stevepiercy]

@pauleveritt would you please comment on @tshepang suggestion, since I see you may have recently addressed this issue? Thank you!

[pauleveritt]

It was my intent to only document stuff that had changed, so if there are cases where I included unchanged code, that's a bug.

Other notes, based on my doing some docs work this week:

• I believe all the inclusions of logging setup in development.ini should be removed, default logging is sufficient under wsgiref I believe
• I made another failed try at eliminating setup.py per step. I would really like a way to do that which preserves the flow of development.
• I have a pyramid_tutorials branch where I am starting a pyramid add ons developer guide
• This has me thinking about how we organize pyramid_tutorials and even the cookbook. We need improvement there.

[stevepiercy]

Closing this issue as there is no specific reference to duplicated code snippets.

@tshepang Feel free to reopen this issue citing any specific duplication.

@pauleveritt Please create new issues or PRs with your list of notes, if you think doing these items are necessary.

Thank you!

[pauleveritt]

Thanks for closing this, Steve. Really, the "Humans" tutorial is superseded by the official Quick Tutorial. I don't know what we should do for such a case. If we remove it, we break URLs. If we leave it in, with a banner saying "Obsolete" (like old branches of Pyramid docs), we still have something misleading out there.

Any thoughts?

[tshepang]

I vote for breaking the URLs

[stevepiercy]

@pauleveritt Where are the URLs that would be broken?

• URLs relative to this repo should get broken and go away, except for a milepost, like this one (https://github.com/Pylons/pyramid_tutorials/blob/master/getting_started/index.rst). (RTD builds for pyramid_tutorials are broken at the moment because I'm dumb and forgot to ask @blaflamme to make me an Owner.)
• URLs on search engines, meh, don't care, indexing will fix that eventually.
• URLs in other Pylons Project repos that point to this repo, let's find and fix 'em.

[pauleveritt]

I mostly meant search engines. I don’t know if there are any old blog posts or stack overflow things out there.

—Paul

On Aug 25, 2015, at 10:41 AM, Steve Piercy notifications@github.com wrote:

@pauleveritt https://github.com/pauleveritt Where are the URLs that would be broken?

URLs relative to this repo should get broken and go away, except for a milepost, like this one (https://github.com/Pylons/pyramid_tutorials/blob/master/getting_started/index.rst https://github.com/Pylons/pyramid_tutorials/blob/master/getting_started/index.rst). (RTD builds for pyramid_tutorials are broken at the moment because I'm dumb and forgot to ask @blaflamme https://github.com/blaflamme to make me an Owner.) URLs on search engines, meh, don't care, indexing will fix that eventually. URLs in other Pylons Project repos that point to this repo, let's find and fix 'em. — Reply to this email directly or view it on GitHub https://github.com/Pylons/pyramid_tutorials/issues/15#issuecomment-134608912.

[stevepiercy]

This might handle it. https://docs.readthedocs.org/en/latest/user-defined-redirects.html

[stevepiercy]

Nope. It doesn't handle it, except on a page-by-page basis, which is a ridiculous amount of work. Also RTD does not yet provide a default 404 page per project. I'm inclined to let this one go by the wayside.

@pauleveritt Should I get rid of Humans, too, like I did the Getting Started? http://docs.pylonsproject.org/projects/pyramid-tutorials/en/latest/getting_started/index.html

[pauleveritt]

Agreed, and yes to humans.

—Paul

On Aug 25, 2015, at 11:19 AM, Steve Piercy notifications@github.com wrote:

Nope. It doesn't handle it, except on a page-by-page basis, which is a ridiculous amount of work. Also RTD does not yet provide a default 404 page per project. I'm inclined to let this one go by the wayside.

@pauleveritt https://github.com/pauleveritt Should I get rid of Humans, too, like I did the Getting Started? http://docs.pylonsproject.org/projects/pyramid-tutorials/en/latest/getting_started/index.html http://docs.pylonsproject.org/projects/pyramid-tutorials/en/latest/getting_started/index.html — Reply to this email directly or view it on GitHub https://github.com/Pylons/pyramid_tutorials/issues/15#issuecomment-134620925.