documentatoin advice!

Asked by Vivek Sharma

Hi all,

i am already hosting a project on launchpad, as now launchpad doesnt have any good support for documentation, like wiki features at sourceforge and googlecode.
What is the usual/personal practice for the documentations, do you create a separate project for documentation to and upload ur daily backups. or create a folder called docs in the project-root, and upload with single bzr push.

- is there a way to download the bazaar book, as pdf. as i am not always connected to the net.

thanks
Vivek Sharma.

Question information

Language:
English Edit question
Status:
Solved
For:
Launchpad itself Edit question
Assignee:
No assignee Edit question
Solved by:
Vivek Sharma
Solved:
Last query:
Last reply:
Revision history for this message
Julian Edwards (julian-edwards) said :
#1

I think that which of these options you use is entirely down to personal preference, but of course you can't beat the convenience of using bzr to push changes to Launchpad.

As for the bazaar book, can you make a local branch or checkout of lp:bzr-book? Once you have it you can use it offline.

Revision history for this message
Vivek Sharma (sharmavivek) said :
#2

Thanks Julian,

how do one uses launchpad to write/maintain a book. Are all the chapters suppose to in the source-code tab, like other source include folder. Or is there a special way?

I could download the book
> bzr branch lp:bzr-book

This just gave me a Readme file saying "This is the place holder for bazaar book"

thanks

Revision history for this message
Julian Edwards (julian-edwards) said :
#3

Hi

If you want a revision-controlled set of files, you can use Launchpad Codehosting. It's called "Codehosting" but in fact you can store any file you like provided it's licensed with an open licence. This page is a good start for help: https://help.launchpad.net/Code

Regarding your other question, in that case I'm not sure what you are after, what resource are you currently looking at that requires 'net access?

Revision history for this message
Vivek Sharma (sharmavivek) said :
#4

Hello,

I am sorry, i meant "I COULD NOT download the book" by the command
> bzr branch lp:bzr-book

What i got was only a file.
A Readme file saying "This is the place holder for bazaar book"

I have maintained few ZIM-wiki based books on my machine. I made a pbook project on launchpad, and uploaded all the files (notebooks to it). Which i am not able to access it :). As you have deleted it.

Well, ofcourse the material is open-source, its tips/tricks/code-snippets/hacks/algorithms... and some-other things. What i asked was, since bazaar book is a book, non-code files, and launchpad is maintaining a repository of it. I guess the way to do this is through upload all the files as into the main branch of the project "bzr-book".
If this is how it is done, i tried to do the same for my notebooks/book. Pushed all the files to pnotes/main.

IF not, is bzr-book using any other feature, which provides special hosting to non-code document files.

thanks

Revision history for this message
Vivek Sharma (sharmavivek) said :
#5

Hello,

I am sorry, i meant "I COULD NOT download the book" by the command
> bzr branch lp:bzr-book

What i got was only a file.
A Readme file saying "This is the place holder for bazaar book"

I have maintained few ZIM-wiki based books on my machine. I made a pbook project on launchpad, and uploaded all the files (notebooks to it). Which i am not able to access it :). As you have deleted it.

Well, ofcourse the material is open-source, its tips/tricks/code-snippets/hacks/algorithms... and some-other things. What i asked was, since bazaar book is a book, non-code files, and launchpad is maintaining a repository of it. I guess the way to do this is through -- upload all the files, into the main branch of the project "bzr-book". This main branch will show at http://www.launchpad.net/bzr-book/main

If this is how it is done, i tried to do the same for my notebooks/book. Pushed all the files to ~pnotes/main.

IF not, is bzr-book using any other feature, which provides special hosting to non-code document files.

If i am offline, and working on my code, and have to do a commit or anything to my local repository, i have help, so i was looking for a way to have the bzr-book available offline. I am new to SCM bazaar, ie y need a book to corrrect if i am doing something wrong, even if it basic for others.

thanks :)
vks

Revision history for this message
Julian Edwards (julian-edwards) said :
#6

Hi

Your "download" worked, but the bzr-book branch seems to have only that file in it. This is why I was asking more about what you wanted to see - now I understand what you want, I can point you here:
http://bazaar-vcs.org/Documentation
where there are some downloadable guides for you.

I disabled the pnotes project earlier as it looked bogus from the description you wrote. I will re-enable it, but please give it a more detailed description otherwise it will may disabled again by someone else who reviews your project.

Thanks!

Revision history for this message
Julian Edwards (julian-edwards) said :
#7

One more thing, please change it from "Just personal notes", this is not a useful project name and will be disabled as a non-open project otherwise.

Revision history for this message
Vivek Sharma (sharmavivek) said :
#8

Sure Julian, and thanks :)