Make docs repo the official docs

classic Classic list List threaded Threaded
10 messages Options
Reply | Threaded
Open this post in threaded view
|

Make docs repo the official docs

Simon Stewart
Hi,

What's missing from https://github.com/SeleniumHQ/docs for us to be able to make them the official docs of the project? In terms of content, rather than how to stitch them into the site.

We have a site redesign coming for SeleniumHQ, and as part of that, it'd be nice to give the docs a refresh. If there's no reason not to, I'd like to move to the rewritten docs. If there is a reason not to, I'd like to address those, and then move to the rewritten docs.

Cheers,

Simon

--
You received this message because you are subscribed to the Google Groups "Selenium Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/selenium-developers/CAOrAhYHmH_V2y9cOPnb80MmrYe9eH6a55e2WACckReBujXK9gw%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: Make docs repo the official docs

Titus Fortner
As I understand we currently have 2 other places where there is "official-ish" documentation:

I think what should be done to publicize https://github.com/SeleniumHQ/docs as "official" is to make sure the information that exists in these other two is captured in the "official" documentation, which should include getting rid of the content elsewhere (or spending time replacing wiki content with links to the docs if that makes more sense).

On Mon, Sep 18, 2017 at 2:22 AM, Simon Stewart <[hidden email]> wrote:
Hi,

What's missing from https://github.com/SeleniumHQ/docs for us to be able to make them the official docs of the project? In terms of content, rather than how to stitch them into the site.

We have a site redesign coming for SeleniumHQ, and as part of that, it'd be nice to give the docs a refresh. If there's no reason not to, I'd like to move to the rewritten docs. If there is a reason not to, I'd like to address those, and then move to the rewritten docs.

Cheers,

Simon

--
You received this message because you are subscribed to the Google Groups "Selenium Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/selenium-developers/CAOrAhYHmH_V2y9cOPnb80MmrYe9eH6a55e2WACckReBujXK9gw%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Selenium Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/selenium-developers/CAKSYPuitfR8RtzaQ3DzZb_5%2BsWKEtRuGLsSZ_8u%2BiCCLN08qFw%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: Make docs repo the official docs

Manoj K
Hi Simon,

I had some notes on what's pending. There are quite a few chapters that needs a rewrite, so that its inline with its current way of working, some of those are, 

1. A Quick tour needs to be more details with screenshots showing how to setup a selenium project using different drivers that we support. 
2. Add Logo (PR raised)  
3. Add code samples for different language, atm its just Python/Ruby and Java in random.
4. Add any W3C specific documentation
5. Advanced User Interactions (Actions class, HTTP proxies, Page Load strategy )
6. More details on using Selenium Grid.
7. WebDriver Introduction to say about Selenium 3 and W3C API
8. Maybe add Screen play pattern on Guidelines and recommendation ? asking people to move from using Page(factory) Object Pattern?
9. Add docker-selenium related docs or just refer them to the repository.

Am currently in the verge of moving countries, hoping I will work on these after I get settled in, that said anyone can pick up and work on it :)

Regards,
Manoj

--
You received this message because you are subscribed to the Google Groups "Selenium Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/selenium-developers/055b0564-277f-4732-b708-e18128ff12e6%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: Make docs repo the official docs

Titus Fortner
Screen play is not a viable replacement for Page Object Pattern even if it were a good idea (which in most cases it is not). Pushing for PageFactory usage in Java/C# repos is an entirely separate concern.

On Mon, Sep 18, 2017 at 7:53 PM, Manoj K <[hidden email]> wrote:
Hi Simon,

I had some notes on what's pending. There are quite a few chapters that needs a rewrite, so that its inline with its current way of working, some of those are, 

1. A Quick tour needs to be more details with screenshots showing how to setup a selenium project using different drivers that we support. 
2. Add Logo (PR raised)  
3. Add code samples for different language, atm its just Python/Ruby and Java in random.
4. Add any W3C specific documentation
5. Advanced User Interactions (Actions class, HTTP proxies, Page Load strategy )
6. More details on using Selenium Grid.
7. WebDriver Introduction to say about Selenium 3 and W3C API
8. Maybe add Screen play pattern on Guidelines and recommendation ? asking people to move from using Page(factory) Object Pattern?
9. Add docker-selenium related docs or just refer them to the repository.

Am currently in the verge of moving countries, hoping I will work on these after I get settled in, that said anyone can pick up and work on it :)

Regards,
Manoj

--
You received this message because you are subscribed to the Google Groups "Selenium Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/selenium-developers/055b0564-277f-4732-b708-e18128ff12e6%40googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Selenium Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/selenium-developers/CAKSYPui4D0Umu8zNf8uS%3DeJtTXO_42E2b_VYnMt6Zav_tTix5g%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: Make docs repo the official docs

Simon Stewart
In reply to this post by Titus Fortner
The original idea was that the wiki was going to be focused on the needs of us as developers of selenium. It'd be nice to go back to that. 

Simon

On Mon, Sep 18, 2017 at 3:43 PM, Titus Fortner <[hidden email]> wrote:
As I understand we currently have 2 other places where there is "official-ish" documentation:

I think what should be done to publicize https://github.com/SeleniumHQ/docs as "official" is to make sure the information that exists in these other two is captured in the "official" documentation, which should include getting rid of the content elsewhere (or spending time replacing wiki content with links to the docs if that makes more sense).

On Mon, Sep 18, 2017 at 2:22 AM, Simon Stewart <[hidden email]> wrote:
Hi,

What's missing from https://github.com/SeleniumHQ/docs for us to be able to make them the official docs of the project? In terms of content, rather than how to stitch them into the site.

We have a site redesign coming for SeleniumHQ, and as part of that, it'd be nice to give the docs a refresh. If there's no reason not to, I'd like to move to the rewritten docs. If there is a reason not to, I'd like to address those, and then move to the rewritten docs.

Cheers,

Simon

--
You received this message because you are subscribed to the Google Groups "Selenium Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/selenium-developers/CAOrAhYHmH_V2y9cOPnb80MmrYe9eH6a55e2WACckReBujXK9gw%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Selenium Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/selenium-developers/CAKSYPuitfR8RtzaQ3DzZb_5%2BsWKEtRuGLsSZ_8u%2BiCCLN08qFw%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Selenium Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/selenium-developers/CAOrAhYG7OFyzoNuim%2Bn-1TWniijGSNaf%3DOOfz33xsEHo48uRgw%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: Make docs repo the official docs

Simon Stewart
In reply to this post by Manoj K
Inline.

On Tue, Sep 19, 2017 at 3:53 AM, Manoj K <[hidden email]> wrote:
Hi Simon,

I had some notes on what's pending. There are quite a few chapters that needs a rewrite, so that its inline with its current way of working, some of those are, 

1. A Quick tour needs to be more details with screenshots showing how to setup a selenium project using different drivers that we support. 

I love this.
 
2. Add Logo (PR raised)  

We have the new branding coming RSN. It'll look a lot more like the stuff we have on the SeConf sites than the checkmark we have now.
 
3. Add code samples for different language, atm its just Python/Ruby and Java in random.

Amen!
 
4. Add any W3C specific documentation

From a user-facing PoV there shouldn't really be a difference. We might need to let people know about `Interactive` as a helper API, but even that shouldn't be a "w3c vs JWP" thing.
 
5. Advanced User Interactions (Actions class, HTTP proxies, Page Load strategy )
6. More details on using Selenium Grid.
7. WebDriver Introduction to say about Selenium 3 and W3C API

Again, the shouldn't really be a difference for a user. For an implementor, there is.
 
8. Maybe add Screen play pattern on Guidelines and recommendation ? asking people to move from using Page(factory) Object Pattern?

+1 to linking to the screenplay pattern, especially after introducing Page Objects. The former builds on the latter by taking the dials and turning them to 11. The problem with Screen Play is that it's even more open to misinterpretation than Page Objects.
 
9. Add docker-selenium related docs or just refer them to the repository

Yes, but since that's not there, I imagine this isn't quite so pressing.
 
Am currently in the verge of moving countries, hoping I will work on these after I get settled in, that said anyone can pick up and work on it :)

Good luck with the move!

Cheers,

Simon
 
Regards,
Manoj

--
You received this message because you are subscribed to the Google Groups "Selenium Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/selenium-developers/055b0564-277f-4732-b708-e18128ff12e6%40googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Selenium Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/selenium-developers/CAOrAhYGFwawj9U5gNfDiB8%3D1K%3D97_Wdj5QjiaSgwo1-dZ2F0Hg%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: Make docs repo the official docs

Andreas Tolfsen-2
In reply to this post by Simon Stewart
Also sprach Simon Stewart:

> What's missing from https://github.com/SeleniumHQ/docs for us to
> be able to make them the official docs of the project? In terms of
> content, rather than how to stitch them into the site.

The documentation rewrite never quite got the time and
attention it needed to be a competitive replacement for
http://www.seleniumhq.org/docs/.  I still think providing high
quality documentation will determine the future success of Selenium,
and I still hold to the belief that a software project is only as
good as its documentation.

> We have a site redesign coming for SeleniumHQ, and as part of
> that, it'd be nice to give the docs a refresh. If there's no
> reason not to, I'd like to move to the rewritten docs. If there is
> a reason not to, I'd like to address those, and then move to the
> rewritten docs.

As others have pointed out there are significant chapters and
content missing.  I believe this project needs someone with time and
energy to lead the rewriting process.  As the original instigator
of the Selenium documentation rewrite, I want to add that I’m
stepping down as its maintainer, but I still think it’s a
worthwhile project.

--
You received this message because you are subscribed to the Google Groups "Selenium Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/selenium-developers/1505826565.s8c6hiib42.ato%40sny.no.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: Make docs repo the official docs

⇜Krishnan Mahadevan⇝
In reply to this post by Simon Stewart
Simon,

Sometime back I started to work on documenting my understandings of the Grid.
I collated all of those learnings and put them up under https://rationaleemotions.github.io/gridopadesham/ 

There's still some amount of details that's pending for this. 

The current Documentation for the Selenium Grid found here : https://seleniumhq.github.io/docs/grid.html#selenium_grid

Still lacks information around the following :
  • Adding custom servlets at the Hub and the Node end
  • Adding one's own Capability matcher 
  • Adding one's own prioritizer
  • Adding one's own proxy
  • Enabling Grid support for one's custom WebDriver implementation
  • Building one's own custom renderer.
​I am happy to basically have my learnings be moved into the SeleniumHQ org [ That way one doesn't have to sit and re-type all of that material once again ] as a github repository itself.

I am also fine with having it called as something else.

I named it as Grid-o-padesham [ As per the indian mythology, Krishna's advice to a warrior by name Arjuna were captured as Gitopadesha, so why not capture my learnings about the Grid on the same lines :) ], but am fine with having that changed as well.

Please let me know your thoughts on this.

Thanks & Regards
Krishnan Mahadevan

"All the desirable things in life are either illegal, expensive, fattening or in love with someone else!"
My Scribblings @ http://wakened-cognition.blogspot.com/
My Technical Scribbings @ http://rationaleemotions.wordpress.com/

On Mon, Sep 18, 2017 at 2:52 PM, Simon Stewart <[hidden email]> wrote:
Hi,

What's missing from https://github.com/SeleniumHQ/docs for us to be able to make them the official docs of the project? In terms of content, rather than how to stitch them into the site.

We have a site redesign coming for SeleniumHQ, and as part of that, it'd be nice to give the docs a refresh. If there's no reason not to, I'd like to move to the rewritten docs. If there is a reason not to, I'd like to address those, and then move to the rewritten docs.

Cheers,

Simon

--
You received this message because you are subscribed to the Google Groups "Selenium Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/selenium-developers/CAOrAhYHmH_V2y9cOPnb80MmrYe9eH6a55e2WACckReBujXK9gw%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Selenium Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/selenium-developers/CANikZLnTCBkdYbvch5%3DxasNfWuwr4zg2kN8xgp7_9qpLWXNfwA%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: Make docs repo the official docs

⇜Krishnan Mahadevan⇝

Bumping this thread to see if this would elicit any sort of interest

 

 

Thanks & Regards

Krishnan Mahadevan

 

"All the desirable things in life are either illegal, expensive, fattening or in love with someone else!"

My Scribblings @ http://wakened-cognition.blogspot.com/

My Technical Scribbings @ http://rationaleemotions.wordpress.com/

 

From: Krishnan Mahadevan <[hidden email]>
Date: Sunday, November 19, 2017 at 11:10 AM
To: Selenium Developers <[hidden email]>
Subject: Re: [selenium-developers] Make docs repo the official docs

 

Simon,

 

Sometime back I started to work on documenting my understandings of the Grid.

I collated all of those learnings and put them up under https://rationaleemotions.github.io/gridopadesham/ 

 

There's still some amount of details that's pending for this. 

 

The current Documentation for the Selenium Grid found here : https://seleniumhq.github.io/docs/grid.html#selenium_grid

 

Still lacks information around the following :

  • Adding custom servlets at the Hub and the Node end
  • Adding one's own Capability matcher 
  • Adding one's own prioritizer
  • Adding one's own proxy
  • Enabling Grid support for one's custom WebDriver implementation
  • Building one's own custom renderer.

​I am happy to basically have my learnings be moved into the SeleniumHQ org [ That way one doesn't have to sit and re-type all of that material once again ] as a github repository itself.

 

I am also fine with having it called as something else.

 

I named it as Grid-o-padesham [ As per the indian mythology, Krishna's advice to a warrior by name Arjuna were captured as Gitopadesha, so why not capture my learnings about the Grid on the same lines :) ], but am fine with having that changed as well.

 

Please let me know your thoughts on this.


Thanks & Regards
Krishnan Mahadevan

"All the desirable things in life are either illegal, expensive, fattening or in love with someone else!"
My Scribblings @ http://wakened-cognition.blogspot.com/

My Technical Scribbings @ http://rationaleemotions.wordpress.com/

 

On Mon, Sep 18, 2017 at 2:52 PM, Simon Stewart <[hidden email]> wrote:

Hi,

 

What's missing from https://github.com/SeleniumHQ/docs for us to be able to make them the official docs of the project? In terms of content, rather than how to stitch them into the site.

 

We have a site redesign coming for SeleniumHQ, and as part of that, it'd be nice to give the docs a refresh. If there's no reason not to, I'd like to move to the rewritten docs. If there is a reason not to, I'd like to address those, and then move to the rewritten docs.

 

Cheers,

 

Simon

--
You received this message because you are subscribed to the Google Groups "Selenium Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/selenium-developers/CAOrAhYHmH_V2y9cOPnb80MmrYe9eH6a55e2WACckReBujXK9gw%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

 

--
You received this message because you are subscribed to the Google Groups "Selenium Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/selenium-developers/4618F711-7374-467D-89E9-E6A534CE40FC%40gmail.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: Make docs repo the official docs

cassian
In reply to this post by Simon Stewart
Very detailed and found it informative

Cheers!!!

On Monday, September 18, 2017 at 2:52:22 PM UTC+5:30, Simon Stewart wrote:
Hi,

What's missing from <a href="https://github.com/SeleniumHQ/docs" target="_blank" rel="nofollow" onmousedown="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fgithub.com%2FSeleniumHQ%2Fdocs\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNEFuf4TMHqTe7itEsgekQNeAQexAg&#39;;return true;" onclick="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fgithub.com%2FSeleniumHQ%2Fdocs\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNEFuf4TMHqTe7itEsgekQNeAQexAg&#39;;return true;">https://github.com/SeleniumHQ/docs for us to be able to make them the official docs of the project? In terms of content, rather than how to stitch them into the site.

We have a site redesign coming for SeleniumHQ, and as part of that, it'd be nice to give the docs a refresh. If there's no reason not to, I'd like to move to the rewritten docs. If there is a reason not to, I'd like to address those, and then move to the rewritten docs.

Cheers,

Simon

--
You received this message because you are subscribed to the Google Groups "Selenium Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/selenium-developers/0f2d75db-2e37-434d-b179-a59819f361b7%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.