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

Remove outdated FAQ page from docs #3683

Merged
merged 5 commits into from
Mar 1, 2023

Conversation

mribeirodantas
Copy link
Member

No description provided.

@bentsherman
Copy link
Member

The FAQ page is really old, and it isn't linked in the nav bar for some reason.

@pditommaso What do you want to do with the FAQ page? Do you think it's worth keeping?

@pditommaso
Copy link
Member

pditommaso commented Feb 24, 2023

Yeah, it's really outdated. I'd say to remove and rewrite from scratch on https://github.com/nextflow-io/nextflow/discussions

@bentsherman
Copy link
Member

@mribeirodantas Are you up to the task? The goal would be to scan the Q&A discussions and pick out the questions that come up repeatedly or seem important, and collect them into an FAQ page for the Nextflow docs. It could probably be done over the course of a few doc sessions.

@mribeirodantas
Copy link
Member Author

The FAQ page is really old, and it isn't linked in the nav bar for some reason.
Yeah, it disappeared from the nav bar, but you can still find it through the search box. I (and I believe other people) always landed there when I searched for the bin folder, for example.

I think it's good to have a FAQ section in the official docs, and also to mention the Nextflow Patterns website there. So we're gonna keep the FAQ in the docs?

@bentsherman
Copy link
Member

@mribeirodantas Check this thread again, I think you missed a few of our comments.

We're saying, scrap the current FAQ page and re-create it from scratch. Many of those FAQs aren't as relevant any more. Instead you can go through the Q&A Discussions page to find good FAQs, i.e. questions that are asked there repeatedly or just seem worth documenting.

@mribeirodantas
Copy link
Member Author

I had read all comments, but I thought Paolo meant something different. So we're really gonna keep the FAQ [section] in the docs, but with new questions and answers. Great for me! 🥳 I will work on it.

@pditommaso
Copy link
Member

Hi @mribeirodantas, thanks for improving this, but I agree with Ben the FAQ content and structure are quite outdated.

Also, it would be better not to keep it in the docs but in the GitHub discussion to allow a quicker iteration/editing and promote a better interaction with the community

@mribeirodantas
Copy link
Member Author

Ok, as I had understood your message initially then. I will delete the FAQ pages then.

The FAQ page was already left out of the index / nav bar, but
could still be found wiht the search bar. In a discussion in
this PR (nextflow-io#3683),
Paolo decided it's better to leave it in the GitHub Discussions
instead of the docs.

Signed-off-by: Marcel Ribeiro-Dantas <mribeirodantas@seqera.io>
@mribeirodantas
Copy link
Member Author

LGTM?

@bentsherman bentsherman changed the title Update FAQ in the docs to DSL2 [skip ci] Remove outdated FAQ page from docs Feb 28, 2023
@pditommaso
Copy link
Member

Vamos!

@pditommaso pditommaso merged commit e59c7fb into nextflow-io:master Mar 1, 2023
@mribeirodantas
Copy link
Member Author

🇧🇷 🥳

abhi18av pushed a commit to abhi18av/nextflow that referenced this pull request Oct 28, 2023
The FAQ page was already left out of the index / nav bar, but
could still be found wiht the search bar. In a discussion in
this PR (nextflow-io#3683),
Paolo decided it's better to leave it in the GitHub Discussions
instead of the docs.

Signed-off-by: Marcel Ribeiro-Dantas <mribeirodantas@seqera.io>

---------

Signed-off-by: Marcel Ribeiro-Dantas <mribeirodantas@seqera.io>
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