Sneak peek to new documentation page for SpecFlow

[Andreas Willich]

Hi all!

In the last weeks, we were working on a new website for the documentation for SpecFlow, SpecFlow+ Runner and SpecFlow+ LivingDoc.

It's not yet completely 100% finished, but we would like to get early feedback from you.

You can access it at https://docs.specflow.org/

We took over all the content of the existing documentation and changed the TOC.

Some cool features of the new documentation page are:

• integrated search
• mobile-friendly
• everything is in the same git repo as the project (for SpecFlow it is https://github.com/SpecFlowOSS/SpecFlow/tree/master/docs)
• support for multiple versions (not yet available, this will come with next bigger release)

The plan is to go live with it in the next two weeks.

If you have feedback for us or found an issue (e.g. broken link), please let us know here, open an issue or create a pull request with the fix.

Andreas

[praveenreddy narala]

Hi Team,

Great work. This is been pending for a long time. Now, wait comes to an end. 

I have a small suggestion if you could add examples in every document, will become self-explanatory for any person. Also, please include Azure and Gitflows with a live or working example.

Thank you.

Regards,

Praveen 

--
You received this message because you are subscribed to the Google Groups "SpecFlow" group.
To unsubscribe from this group and stop receiving emails from it, send an email to specflow+u...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/specflow/ef1d789f-5f29-4aac-b939-0182ea78e6f5o%40googlegroups.com.

[Alvord, Gregory]

I like the new search feature having scope over all documentation. 

 

Seems the a multi word search “Word1 Word2” is treated as  “Word1  OR Word2”.  How would I express “Word1 AND Word 2”?

 

From: spec...@googlegroups.com <spec...@googlegroups.com> On Behalf Of Andreas Willich
Sent: Friday, July 3, 2020 4:14 AM
To: SpecFlow <spec...@googlegroups.com>
Subject: [specflow] Sneak peek to new documentation page for SpecFlow

 

IMPORTANT!! - External Content - Please use caution.

--

You received this message because you are subscribed to the Google Groups "SpecFlow" group.
To unsubscribe from this group and stop receiving emails from it, send an email to specflow+u...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/specflow/ef1d789f-5f29-4aac-b939-0182ea78e6f5o%40googlegroups.com.

The information contained in this message is proprietary and/or confidential. If you are not the intended recipient, please: (i) delete the message and all copies; (ii) do not disclose, distribute or use the message in any manner; and (iii) notify the sender immediately. In addition, please be aware that any message addressed to our domain is subject to archiving and review by persons other than the intended recipient. Thank you.

[Andreas Willich]

Thanks for the feedback

@Praveen: About your question for documentation for Azure and Gitflows.

Do you mean Azure DevOps with Azure? Or something else?

The Azure DevOps documentation needs to be improved. 

But if you mean Azure, what would you expect here as documentation?

Same for Gitflows. I only know this as a branching strategy for git. Not sure what it has to do with SpecFlow. Could you elaborate here, what you are looking for?

@Alvord:

We are using the search that is provided by ReadTheDocs and AFAIK they are using Elastic for it.

Here is the documentation I found for it: https://docs.readthedocs.io/en/latest/guides/searching-with-readthedocs.html#search-query-syntax

Cheers,

Andi

To view this discussion on the web visit https://groups.google.com/d/msgid/specflow/BN3PR04MB2148F9253F55DBCFA6994606F66B0%40BN3PR04MB2148.namprd04.prod.outlook.com.

[praveenreddy narala]

Hi Andreas,

Kindly find my ask.

Azure: Running SpecFlow tests from Azure pipeline and add live documentation build task step by step with screenshots/examples (we have an example for live documentation build task setup).

Regards,

Praveen

 

To view this discussion on the web visit https://groups.google.com/d/msgid/specflow/CAKd_x%2Ban41_zJZtNJv5vXM2J9Ug6n7dVUDVGuTiYYw0mPJi3%3Dw%40mail.gmail.com.