Giter Site home page Giter Site logo

Comments (3)

 avatar commented on September 17, 2024

Ftr, I have no stakes in this issue, I just randomly stumbled across this file because it was linked from somewhere.

Lana just explained to me that removal from the sidebar tree might be the precursor to files being deleted. I am a bit confused about that practice -- because taking it out of the sidebar tree does not look intentional or explicit to me, and there is no discernible difference to an actual bug. Maybe a note saying "hey, do you think this document is helpful? please file a bug report or it will be removed next week" (paraphrasing, obviously) might be a more explicit way of achieving this..?

from uyuni-docs.

Loquacity avatar Loquacity commented on September 17, 2024

So I think this case might actually be an error. Investigating now.

from uyuni-docs.

Loquacity avatar Loquacity commented on September 17, 2024

Lana just explained to me that removal from the sidebar tree might be the precursor to files being deleted. I am a bit confused about that practice -- because taking it out of the sidebar tree does not look intentional or explicit to me, and there is no discernible difference to an actual bug. Maybe a note saying "hey, do you think this document is helpful? please file a bug report or it will be removed next week" (paraphrasing, obviously) might be a more explicit way of achieving this..?

This is a result of the major content reorganisations we've been doing over the past couple of releases, and also a function of how our search tool works. Usually, we determine that the content needs to be moved elsewhere in the suite, so we comment out the page in the nav, leave a comment to explain why and where the content has moved to (datestamped), but leave the page published. This means that when we come across the page next, we can make an educated guess about whether or not to delete the page, based on how much time has elapsed, and whether or not anyone has yelled. Our search tool indexes the entire suite, not just the pages linked in the nav, so it will turn up results that have been delinked. That means that we have been able to use this method as a sort of "soft" deletion, which has been useful with all the content restructures we have been dealing with. All that said, I do agree that a more formal process is probably required. Now that our docs suite is starting to stabilise, that is something we will be able to introduce. I'll add it to my list, and make sure it gets discussed in planning.

from uyuni-docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.